Skip to main content

Type Alias: HelpIntegrationConfiguration

HelpIntegrationConfiguration: Omit<ApplicationFlag<CommandContext>, "name" | "aliases" | "global" | "run"> & object

Options for customizing the behavior of the help integration.

Type declaration

alias?

readonly optional alias: AvailableAlias | false

Single-character shorthand alias for this flag, defaults to h if not provided. Set to false to disable the alias entirely.

formatting

readonly formatting: FormattingConfiguration

Configuration for controlling how printed documentation is formatted.

includeHidden?

readonly optional includeHidden: boolean

When printing help text, if this flag is set to true, hidden flags and routes will be included in the output. Defaults to false.

Defined in

packages/core/src/application/integrations/help.ts:12