Interface: DocumentationHeaders

Section header strings used to build help text.

Properties

aliases

readonly aliases: string

Header for help text section that lists all aliases for the route.

Defaults to "ALIASES".

Defined in

packages/core/src/text.ts:36

---

arguments

readonly arguments: string

Header for help text section that lists all arguments accepted by the command.

Defaults to "ARGUMENTS".

Defined in

packages/core/src/text.ts:54

---

commands

readonly commands: string

Header for help text section that lists all commands in a route map.

Defaults to "COMMANDS".

Defined in

packages/core/src/text.ts:42

---

flags

readonly flags: string

Header for help text section that lists all flags accepted by the route.

Defaults to "FLAGS".

Defined in

packages/core/src/text.ts:48

---

usage

readonly usage: string

Header for help text section that lists all usage lines.

Defaults to "USAGE".

Defined in

packages/core/src/text.ts:30