FlagDefinitionFragmentV1
A flag entry inside a definition document.
Optional fields appear only when the flag sets them; defaultValue appears only for non-sensitive inputs when the value survives a JSON round-trip.
- Import:
@kjanat/dreamcli - Export kind: type
- Declared in:
src/core/json-schema/index.ts - Source link:
src/core/json-schema/index.ts:309
Signatures
ts
type FlagDefinitionFragmentV1 = FlagElementFragmentV1 & { completionValues?: readonly string[]; defaultDescription?: string | false; sensitive?: true; group?: string; advanced?: true; };Members
Members
kind
ts
kind: FlagKind;presence
ts
presence: FlagPresence;defaultValue
ts
defaultValue?: unknown;aliases
ts
aliases?: readonly string[];stdin
ts
stdin?: StdinBindingFragmentV1;envVar
ts
envVar?: string;envIndexed
ts
envIndexed?: EnvIndexedFragmentV1;envAbsolute
ts
envAbsolute?: true;configPath
ts
configPath?: string;description
ts
description?: string;enumValues
ts
enumValues?: readonly string[];numberConstraints
ts
numberConstraints?: NumberConstraints;stringConstraints
ts
stringConstraints?: FlagStringConstraintsFragmentV1;elementSchema
ts
elementSchema?: FlagElementFragmentV1;separator
ts
separator?: string;split
ts
split?: SourceSplitFragmentV1;duplicateKeys
ts
duplicateKeys?: DuplicateKeys;unique
ts
unique?: true;pathChecks
ts
pathChecks?: FlagPathChecksFragmentV1;valueHint
ts
valueHint?: string;prompt
ts
prompt?: PromptDefinitionFragmentV1;deprecated
ts
deprecated?: string | true;propagate
ts
propagate?: true;negation
ts
negation?: FlagNegationFragmentV1;separateValue
ts
separateValue?: true;variadic
ts
variadic?: true;duplicates
ts
duplicates?: DuplicatePolicy;completionValues
ts
completionValues?: readonly string[];defaultDescription
ts
defaultDescription?: string | false;sensitive
ts
sensitive?: true;group
Named options section in command help.
ts
group?: string;advanced
Whether the flag is shown only in full text help.
ts
advanced?: true;