`CommandDefinitionFragmentV1`

A command nested inside a definition document.

Fragments carry no schemaVersion. They inherit the version of the document they sit in. The standalone form is CommandDefinitionDocumentV1.

Signatures

type CommandDefinitionFragmentV1 = unknown;

Alternative names accepted for this command.

aliases?: readonly string[];

Positional argument definitions in CLI order.

args: readonly ArgDefinitionFragmentV1[];

Nested subcommand definitions.

commands: readonly CommandDefinitionFragmentV1[];

Human-readable description for help text.

description?: string;

Usage examples attached to the command.

examples?: readonly ExampleDefinitionFragmentV1[];

Named flag definitions keyed by flag name.

flags: Readonly<Record<string, FlagDefinitionFragmentV1>>;

Whether the command is omitted from help listings.

hidden?: true;

The command name used for dispatch.

name: string;