-
Notifications
You must be signed in to change notification settings - Fork 16
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
Add a default Help command #31
Comments
Yeah, I would love to provide some sort of help facility. I started extracting It's tough to find a good paradigm for help when you rely on lazy-loading like we do. |
Do you think help is perhaps where we don't mind taking the hit of loading up all of the code? Or do you think separating help for commands from the commands themselves would be a more effective approach? |
I guess it's not a completely crazy idea to have |
Looks like this happened at some point: https://github.com/Shopify/cli-kit/blob/master/gen/lib/gen/commands/help.rb |
Pretty much every command-line tool needs help, so perhaps we could provide a template command that can be incorporated into projects and provide a sane default set of help. My experience is that CLI tools often have both short-form and long-form descriptions.
The short-form description gets used generally when showing commands in a list (e.g.,
mytool help
showing all commands and a short description). The long-form will be shown in help for just that command (e.g.,mytool help mycommand
).Here's an incredibly rough sketch:
The text was updated successfully, but these errors were encountered: