HelpProps

Index

Properties

• categories
• commands
• config
• delimiter
• header
• options
• params

Properties

optionalcategories

categories?: Categories

Mapping of categories to use for command and option grouping.

optionalcommands

commands?: CommandConfigMap

Mapping of commands, typically sub-commands.

optionalconfig

config?: CommandConfig

Configuration metadata about the current command.

optionaldelimiter

delimiter?: string

Delimiter to prefix within examples. Defaults to "$ ".

optionalheader

header?: string

A header to display at the top of the output.

optionaloptions

options?: OptionConfigMap

Mapping of command options.

optionalparams

params?: ParamConfigList

List of command params.