Interface: HelpPluginOptions
Defined in: packages/plugin-help/src/index.ts:55
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
command? | boolean | Whether to register the help command. Default true | packages/plugin-help/src/index.ts:61 |
examples? | [string, string][] | Examples to show in the help output. Each example is a tuple of [command, description]. | packages/plugin-help/src/index.ts:82 |
flag? | boolean | Whether to register the --help global flag. Default true | packages/plugin-help/src/index.ts:67 |
footer? | string | Footer to show after the help output. | packages/plugin-help/src/index.ts:90 |
formatters? | Partial<Formatters> | Custom formatters for rendering help. | packages/plugin-help/src/index.ts:94 |
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:101 |
header? | string | Header to show before the help output. | packages/plugin-help/src/index.ts:86 |
notes? | string[] | Notes to show in the help output. | packages/plugin-help/src/index.ts:77 |
showHelpWhenNoCommandSpecified? | boolean | Whether to show help when no command is specified. Default true | packages/plugin-help/src/index.ts:73 |