Interface HelpRows

The rows that make up the help information for a command. In order of appearance, the rows are:

  • description
  • usage
  • optionsTitle
  • options
  • subcommandsTitle
  • subcommands
interface HelpRows {
    description?: Column;
    options?: [Column, Column][];
    optionsTitle?: Column;
    subcommands?: [Column, Column][];
    subcommandsTitle?: Column;
    usage: Column;
}

Properties

description? options? optionsTitle? subcommands? subcommandsTitle? usage

Properties

Optionaldescription

description?: Column

The command module's description.

Optionaloptions

options?: [Column, Column][]

A 2 column list of the available options and their descriptions.

OptionaloptionsTitle

optionsTitle?: Column

The title for the options section.

Optionalsubcommands

subcommands?: [Column, Column][]

A 2 column list of the available subcommands and their descriptions.

OptionalsubcommandsTitle

subcommandsTitle?: Column

The title for the subcommands section.

usage

usage: Column

A dynamic usage string based on the resolved commands and their parameters.

Settings

Member Visibility

On This Page

Properties