Interface: HelpPluginOptions

Defined in: index.ts:58

Properties

Property	Type	Description	Defined in
command?	boolean	Whether to register the help command. Default true;	index.ts:64
examples?	MaybeAsyncGetter<[string, string][]>	Examples to show in the help output. Each example is a tuple of [command, description].	index.ts:85
flag?	boolean	Whether to register the --help global flag. Default true;	index.ts:70
footer?	MaybeAsyncGetter<string | void | undefined>	Footer to show after the help output.	index.ts:93
formatters?	Partial<Formatters>	Custom formatters for rendering help.	index.ts:97
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:104
header?	MaybeAsyncGetter<string | void | undefined>	Header to show before the help output.	index.ts:89
notes?	MaybeAsyncGetter<string[]>	Notes to show in the help output.	index.ts:80
showHelpWhenNoCommandSpecified?	boolean	Whether to show help when no command is specified. Default true;	index.ts:76