Interface: HelpPluginOptions

Defined in: index.ts:54

Properties

Property	Type	Description	Defined in
banner?	string	A banner to show before the help output.	index.ts:85
command?	boolean	Whether to register the help command. Default true	index.ts:60
examples?	[string, string][]	Examples to show in the help output. Each example is a tuple of [command, description].	index.ts:81
flag?	boolean	Whether to register the --help global flag. Default true	index.ts:66
formatters?	Partial<Formatters>	Custom formatters for rendering help.	index.ts:89
groups?	GroupsOptions	Group 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:96
notes?	string[]	Notes to show in the help output.	index.ts:76
showHelpWhenNoCommandSpecified?	boolean	Whether to show help when no command is specified. Default true	index.ts:72