Interface: DocumentationBriefs

Short documentation brief strings used to build help text.

Properties

readonly argumentEscapeSequence: string

Documentation brief to be included alongside -- escape sequence in help text. Only present when scanner.allowArgumentEscapeSequence is true.

Defaults to "All subsequent inputs should be interpreted as arguments".

readonly help: string

Documentation brief to be included alongside --help flag in help text.

Defaults to "Print help information and exit".

readonly helpAll: string

Documentation brief to be included alongside --helpAll flag in help text.

Defaults to "Print help information (including hidden commands/flags) and exit".

readonly version: string

Documentation brief to be included alongside --version flag in help text.

Defaults to "Print version information and exit".