Adapt --help output to Click-like format #20

decentral1se · 2020-10-22T19:19:39Z

decentral1se commented

2020-10-22 19:19:39 +00:00

Hey, so I am trying to adapt the help output to what I see the Click Python framework doing. You then need to run --help against the commands to find out their options. We'll have to implement that via getopt/copy+pasta or whatever.

Let me know what you think!

Example is:

➜  abra (new-help) ✔ ./abra --help
Usage: abra [OPTIONS] COMMAND [ARGS]...

Options:
  --config      Stack configuration to use
  --env         Environment variables to load
  --help        Show this message and exit
  --stack       Name of the target stack
  --version     Show program version

Commands:
  context     manage remote swarm contexts
  cp          copy files to a container
  deploy      let 'em rip
  logs        tail logs from a deployed service
  multilogs   tail logs from a whole stackk
  run         run a command in the specified service's container
  secret      manage secrets
  upgrade     upgrade to the latest version

Hey, so I am trying to adapt the help output to what I see the Click Python framework doing. You then need to run `--help` against the commands to find out their options. We'll have to implement that via getopt/copy+pasta or whatever. Let me know what you think! Example is: ``` ➜ abra (new-help) ✔ ./abra --help Usage: abra [OPTIONS] COMMAND [ARGS]... Options: --config Stack configuration to use --env Environment variables to load --help Show this message and exit --stack Name of the target stack --version Show program version Commands: context manage remote swarm contexts cp copy files to a container deploy let 'em rip logs tail logs from a deployed service multilogs tail logs from a whole stackk run run a command in the specified service's container secret manage secrets upgrade upgrade to the latest version ```

decentral1se changed title from ~~First stab at new help~~ to Adapt --help output to Click-like format

2020-10-22 19:20:50 +00:00

decentral1se referenced this pull request

2020-10-22 19:50:04 +00:00

CLI UX scratchpad #21

3wordchant commented

2020-10-23 01:46:55 +00:00

Awesome! I think I can build on this and the sub_secret_help pattern to get some nice per-subcommand / per-sub-subcommand help 👌

Awesome! I think I can build on this and the `sub_secret_help` pattern to get some nice per-subcommand / per-sub-subcommand help 👌

3wordchant referenced this issue from a commit

2020-10-23 01:56:50 +00:00

Merge pull request 'Adapt --help output to Click-like format' (#20) from new-help into main Reviewed-on: https://git.autonomic.zone/autonomic-cooperative/abra/pulls/20