awslabs/soci-snapshotter

[FEATURE] Centralize our CLI Documentation

sondavidb opened this issue · 1 comments

Description

We have our CLI commands scattered throughout our docs. This was due to the original idea that the CLI would primarily be a debugging tool, similar to ctr. We have since moved our CLI to be more production-ready. A nice step towards this would be to have a central location for all of our commands.

Describe the solution you'd like

A file in docs/cli.md breaking down all of our available commands and what they do

Describe any alternative solutions/features you've considered

No action could be done. This results in a poorer user experience for those who which to leverage the CLI for creating/pushing indexes, particularly if we end up making our CLI more robust

Any additional context or information about the feature request

No response

Fixed by #1113