[Feedback] exhaustive reference for cli options

[cyrfer]

Page: /cli

Feedback:

Where is the exhaustive reference for options to commands like amplify init ?

I'm looking for something like: https://docs.aws.amazon.com/cli/latest/reference/

[swyxio]

i like this idea but not sure it has a ton of depth - most amplify ___ commands use prompts rather than CLI flags. still, worth documenting.

[cyrfer]

I only care about coverage. I cannot find descriptions for options on several amplify commands.

Normally, commands support help or -h or --help that describe their options, but I've not been able to find info on options for commands, despite people mentioning those options in other github issues, e.g.

amplify init \
--amplify $AMPLIFY \
--providers $PROVIDERS \
--yes

https://github.com/aws-amplify/amplify-cli/issues/3292

Documention like this is built into some CLI frameworks, like oclif.

[dabit3]

If we were to put this in the docs, where would it make sense for us to provide it?

[cyrfer]

hey @dabit3

I think you can put them anywhere. Some ideas (maybe all of them):

1. (edit) -h and --help cli switches
2. in the body of https://docs.amplify.aws/cli
   • specifically https://docs.amplify.aws/cli#reference
3. make the docs here more detailed: https://github.com/aws-amplify/amplify-cli#commands-summary
4. another item under Reference

[dsypniewski]

I just found this https://docs.amplify.aws/cli/usage/headless Maybe someone here will find it useful as I just did, but still built in -h/--help and at least some reference to the headless page from already mentioned places like "Reference" section would be nice as well.

[swyxio]

fwiw I strongly agree that any professional quality CLI should support standard conventions like - - help. it's just that the ask here is also for a web version. I don't mind putting one together.

pinging @renebrandel for this feedback on the cli