CommandDefinitionDocument
The current single-command definition document.
- Import:
@kjanat/dreamcli - Export kind: type
- Declared in:
src/core/json-schema/index.ts - Source link:
src/core/json-schema/index.ts:453
Signatures
type CommandDefinitionDocument = CommandDefinitionDocumentV1;Members
Members
name
The command name used for dispatch.
name: string;description
Human-readable description for help text.
description?: string;details
Longer explanation shown only in this command's help.
details?: string;aliases
Alternative names accepted for this command.
aliases?: readonly string[];hidden
Whether the command is omitted from help listings.
hidden?: true;examples
Usage examples attached to the command.
examples?: readonly ExampleDefinitionFragmentV1[];flags
Named flag definitions keyed by flag name.
flags: Readonly<Record<string, FlagDefinitionFragmentV1>>;flagDeclarationOrder
Flag declaration order when it differs from the flag record's key order.
flagDeclarationOrder?: readonly string[];args
Positional argument definitions in CLI order.
args: readonly ArgDefinitionFragmentV1[];constraints
Declarative relationships between the command's inputs.
constraints?: readonly CommandConstraint[];commands
Nested subcommand definitions.
commands: readonly CommandDefinitionFragmentV1[];schemaVersion
Definition document format version.
schemaVersion: 1;envPrefix
CLI-wide env namespace the command runs under, read the same way as DefinitionDocumentV1.envPrefix.
envPrefix?: string;groupOrder
Named help groups to display first, in order, for this command.
groupOrder?: readonly string[];