Skip to content

Interface: CommandHelpOptions

Defined in: index.ts:20

Extends

Properties

examples?

ts
optional examples: [string, string][];

Defined in: index.ts:35

Examples to show in the help output. Each example is a tuple of [command, description].


group?

ts
optional group: string;

Defined in: index.ts:17

The group this item belongs to. The group must be defined in the groups option of helpPlugin().

Inherited from

HelpOptions.group


notes?

ts
optional notes: string[];

Defined in: index.ts:30

Notes to show in the help output.


show?

ts
optional show: boolean;

Defined in: index.ts:26

Whether to show the command in help output.

Default

ts
true;

Released under the MIT license