Interface: HelpPluginOptions

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

Properties

banner?

optional banner: string;

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

A banner to show before the help output.

---

command?

optional command: boolean;

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

Whether to register the help command.

Default

true;

---

examples?

optional examples: [string, string][];

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

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

---

flag?

optional flag: boolean;

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

Whether to register the --help global flag.

Default

true;

---

formatters?

optional formatters: Partial<Formatters>;

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

Custom formatters for rendering help.

---

groups?

optional groups: GroupsOptions;

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

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.

---

notes?

optional notes: string[];

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

Notes to show in the help output.

---

showHelpWhenNoCommandSpecified?

optional showHelpWhenNoCommandSpecified: boolean;

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

Whether to show help when no command is specified.

Default

true;