Skip to content

Enhancement: allow help option to contain values that influence the help output #3782

@martinlingstuyl

Description

@martinlingstuyl

Currently, the --help option prints the entire command documentation page to the terminal.

As the help pages grow with extra content, this has the side effect of adding unnecessary clutter that's more a hindrance than a help for the user.

I propose that we change this behavior in the following manner:

  • allow for the following values in the help option: options, examples, remarks, response, full.
  • when not specifying a value, it should default to full.
  • the help will print the usage section plus the users chosen section.
  • we implement a new config key: helpMode, which can be used to configure a default value: options, examples, remarks, full, response

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions