Skip to content

Interface: HelpPluginOptions

Defined in: index.ts:55

Properties

PropertyTypeDescriptionDefined in
command?booleanWhether to register the help command. Default trueindex.ts:61
examples?[string, string][]Examples to show in the help output. Each example is a tuple of [command, description].index.ts:82
flag?booleanWhether to register the --help global flag. Default trueindex.ts:67
footer?stringFooter to show after the help output.index.ts:90
formatters?Partial<Formatters>Custom formatters for rendering help.index.ts:94
groups?GroupsOptionsGroup definitions for commands and flags. Groups allow organizing commands and flags into logical sections in help output. Each group is defined as [key, name] where key is the identifier used in help options and name is the display name shown in help output.index.ts:101
header?stringHeader to show before the help output.index.ts:86
notes?string[]Notes to show in the help output.index.ts:77
showHelpWhenNoCommandSpecified?booleanWhether to show help when no command is specified. Default trueindex.ts:73

Released under the MIT license