Skip to content

New Experience best practice request: help #6

Description

@lirantal

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions