Interface: HelpPluginOptions

Defined in: packages/plugin-help/src/index.ts:57

Properties

Property	Type	Description	Defined in
command?	boolean	Whether to register the help command. Default true;	packages/plugin-help/src/index.ts:63
examples?	[string, string][]	Examples to show in the help output. Each example is a tuple of [command, description].	packages/plugin-help/src/index.ts:84
flag?	boolean	Whether to register the --help global flag. Default true;	packages/plugin-help/src/index.ts:69
footer?	string	Footer to show after the help output.	packages/plugin-help/src/index.ts:92
formatters?	Partial<Formatters>	Custom formatters for rendering help.	packages/plugin-help/src/index.ts:96
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.	packages/plugin-help/src/index.ts:103
header?	string	Header to show before the help output.	packages/plugin-help/src/index.ts:88
notes?	string[]	Notes to show in the help output.	packages/plugin-help/src/index.ts:79
showHelpWhenNoCommandSpecified?	boolean	Whether to show help when no command is specified. Default true;	packages/plugin-help/src/index.ts:75