Skip to content

Document standard CLI help format #224

@SteveLasker

Description

@SteveLasker

The CLI has a few options for how to represent help contents.
This issue tracks a proposal for that format to include:

  • Include format for positional arguments
  • Include format for global arguments
  • Include format for examples
  • Formatting, including the command and whether : is specified.

See #223 for an example for why a formatting template is needed across multiple PRs

Metadata

Metadata

Labels

UXUser experience changes

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions