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.

Sign up for GitHub

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

Jump to bottom

New Experience best practice request: help #6

Open
lirantal opened this issue Feb 14, 2020 · 1 comment
Open

New Experience best practice request: help #6

lirantal opened this issue Feb 14, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@lirantal
Copy link
Owner

Would be nice if someone would like to contribute a section on CLIs supporting help.

My points to make would be:

  • A CLI should support -h and --help to provide help
  • A CLI should show this help if it is ran without arguments (unless it is possible for it to execute well without them)
  • Provide help for sub-commands when those are being used
  • When conflicting args are both provided a clear message should indicate so

This all should be embodied in one item about supporting help.
@lirantal lirantal added the enhancement New feature or request label Feb 14, 2020
@jasonkarns
Copy link
Contributor

Perhaps include a reference to http://docopt.org such that the help output is in a conventional format?

And that any help docs might also be available via man pages?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jasonkarns @lirantal