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

Adding two useful help-related features to the CLI #73

Merged
merged 7 commits into from Jan 2, 2020
Merged

Adding two useful help-related features to the CLI #73

merged 7 commits into from Jan 2, 2020

Conversation

@brimoor
Copy link
Contributor

brimoor commented Jan 1, 2020

This PR adds two convenient features:

  1. Running a naked voxel51 <command> will now print help for that command. Previously, it would just execute the command, which may do something, do nothing, or give an error.

This is useful because a typical pattern for exploring a CLI is to:

  • Run voxel51 to see what the tool is all about (expecting to get help info)
  • See an interesting command in the above list
  • Run voxel51 <command> to learn more about that command (expecting to get help info)
  1. Automagically adding an --all-help flag for all commands that have subcommands. This is useful for seeing everything that one can do with a given command. Or, if one is so inclined, running voxel51 --all-help to see EVERYTHING
@brimoor brimoor added the feature label Jan 1, 2020
@brimoor brimoor self-assigned this Jan 1, 2020
Copy link
Contributor

MikeJeffers left a comment

So helpful!

@brimoor

This comment has been minimized.

Copy link
Contributor Author

brimoor commented Jan 2, 2020

So help. Very docs

@brimoor brimoor merged commit 2643b5b into develop Jan 2, 2020
@brimoor brimoor deleted the cli-help branch Jan 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.