CustomFlagDefinition
Definition of a custom flag.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/schema/flag.ts - Source link:
src/core/schema/flag.ts:573
Signatures
ts
interface CustomFlagDefinition extends FlagDefinitionBase {}Members
Properties
aliases
Short/long aliases as bare names or FlagAlias records.
ts
aliases?: readonly (string | FlagAlias)[];configPath
Dotted config path for config resolution (e.g. 'deploy.region').
ts
configPath?: string;defaultValue
Runtime default value.
ts
defaultValue?: unknown;deprecated
Deprecation marker. true deprecates without a message, a string carries the migration guidance.
ts
deprecated?: string | true;description
Human-readable description for help text.
ts
description?: string;duplicates
How repeated CLI occurrences combine. See DuplicatePolicy.
ts
duplicates?: DuplicatePolicy;envVar
Environment variable name for env resolution.
ts
envVar?: string;kind
Kind discriminator.
ts
kind: "custom";parseFn
Parse function applied to the raw value.
ts
parseFn?: FlagParseFn<unknown>;presence
Presence state.
ts
presence?: "optional" | "required" | "defaulted";prompt
Interactive prompt configuration.
ts
prompt?: PromptConfig;propagate
Whether the flag propagates to descendant commands.
ts
propagate?: boolean;standard
Standard Schema v1 validator applied to the resolved value.
ts
standard?: StandardSchemaV1<unknown, unknown>;valueHint
Help placeholder label ('url' renders as <url>).
ts
valueHint?: string;