ArgDefinitionFragmentV1
A positional arg entry inside a definition document.
Array order carries the CLI position.
- Import:
@kjanat/dreamcli - Export kind: type
- Declared in:
src/core/json-schema/index.ts - Source link:
src/core/json-schema/index.ts:284
Signatures
ts
type ArgDefinitionFragmentV1 = unknown;Members
Properties
configPath
ts
configPath?: string;defaultDescription
ts
defaultDescription?: string | false;defaultValue
ts
defaultValue?: unknown;deprecated
ts
deprecated?: string | true;description
ts
description?: string;duplicateKeys
ts
duplicateKeys?: DuplicateKeys;elementSchema
ts
elementSchema?: ArgElementFragmentV1;enumValues
ts
enumValues?: readonly string[];envVar
ts
envVar?: string;kind
ts
kind: ArgKind;name
ts
name: string;numberConstraints
ts
numberConstraints?: NumberConstraints;pathChecks
ts
pathChecks?: FlagPathChecksFragmentV1;presence
ts
presence: ArgPresence;prompt
ts
prompt?: PromptDefinitionFragmentV1;sensitive
ts
sensitive?: true;separator
ts
separator?: string;split
ts
split?: SourceSplitFragmentV1;stdin
ts
stdin?: StdinBindingFragmentV1;stringConstraints
ts
stringConstraints?: FlagStringConstraintsFragmentV1;unique
ts
unique?: true;valueHint
ts
valueHint?: string;variadic
ts
variadic?: true;