Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Ftr] Consider adding a tip for command --help #93

Open
lread opened this issue Nov 28, 2019 · 3 comments
Open

[Ftr] Consider adding a tip for command --help #93

lread opened this issue Nov 28, 2019 · 3 comments

Comments

@lread
Copy link
Contributor

lread commented Nov 28, 2019

Is your feature request related to a problem? Please describe.
When I invoke a cli-matic with the --help option I get a nice summary of help. For example:

> ./toycalc.clj --help
NAME:
 toycalc - A command-line toy calculator

USAGE:
 toycalc [global-options] command [command options] [arguments...]

VERSION:
 0.0.1

COMMANDS:
   add, a               Adds two numbers together
   sub, s               Subtracts parameter B from A

GLOBAL OPTIONS:
       --base N  10  The number base for output
   -?, --help

But there is no indication that I can get help on a command, for example via
./toycalc.clj add --help

Describe the solution you'd like
Add a tip to the overall help. Maybe something like:

NAME:
 toycalc - A command-line toy calculator

USAGE:
 toycalc [global-options] command [command options] [arguments...]

VERSION:
 0.0.1

COMMANDS:
   add, a               Adds two numbers together
   sub, s               Subtracts parameter B from A

  For help on a command follow the command with --help.

GLOBAL OPTIONS:
       --base N  10  The number base for output
   -?, --help

Describe alternatives you've considered
Perhaps a way of getting all help for all options and all commands at once would be useful.

Additional context
None

@lread
Copy link
Contributor Author

lread commented Nov 29, 2019

If this makes sense to folks, I can submit a PR.

@l3nz
Copy link
Owner

l3nz commented Nov 29, 2019

I would not do it now, as I plan to do major changes as per #69

@lread
Copy link
Contributor Author

lread commented Nov 29, 2019

Thanks for the reply, feel free to close this one if it makes sense to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants