Interface: CommandHelpOptions

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

Extends

• HelpOptions

Properties

examples?

optional examples: [string, string][];

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

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

---

group?

optional group: string;

Defined in: packages/plugin-help/src/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?

optional notes: string[];

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

Notes to show in the help output.

---

show?

optional show: boolean;

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

Whether to show the command in help output.

Default

true;