StringArgDefinition
Definition of a string arg.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/schema/arg.ts - Source link:
src/core/schema/arg.ts:417
Signatures
interface StringArgDefinition extends ArgDefinitionBase {}Members
Properties
aggregateStandard
Standard Schema v1 validator applied to a completed collection.
aggregateStandard?: StandardSchemaV1<unknown, unknown>;configPath
Dotted config path for config resolution (e.g. 'deploy.region').
configPath?: string;defaultValue
Runtime default value.
defaultValue?: unknown;deprecated
Deprecation marker. true deprecates without a message, a string carries the migration guidance.
deprecated?: string | true;description
Human-readable description for help text.
description?: string;envVar
Environment variable name for env resolution.
envVar?: string;kind
Kind discriminator.
kind: "string";pathChecks
Filesystem checks applied after resolution.
pathChecks?: PathChecks;presence
Presence state.
presence?: "optional" | "required" | "defaulted";prompt
Interactive prompt configuration.
prompt?: PromptConfig;separator
CLI value separator each positional token is split on.
separator?: string;split
Env and stdin split policies.
split?: SourceSplitBinding;standard
Standard Schema v1 validator applied to each resolved value.
standard?: StandardSchemaV1<unknown, unknown>;stdin
Stdin binding. See StdinOptions.
stdin?: StdinOptions;stringConstraints
String constraints enforced at the parse and resolution boundaries.
stringConstraints?: StringConstraints;unique
Deduplicate the resolved values of a variadic arg.
unique?: boolean;valueHint
Help placeholder label ('url', 'path', …).
valueHint?: string;variadic
Whether this arg consumes all remaining positionals.
variadic?: boolean;