CustomArgDefinition
Definition of a custom arg.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/schema/arg.ts - Source link:
src/core/schema/arg.ts:356
Signatures
ts
interface CustomArgDefinition extends ArgDefinitionBase {}Members
Properties
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;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?: ArgParseFn<unknown>;presence
Presence state.
ts
presence?: "required" | "optional" | "defaulted";prompt
Interactive prompt configuration.
ts
prompt?: PromptConfig;standard
Standard Schema v1 validator applied to the resolved value.
ts
standard?: StandardSchemaV1<unknown, unknown>;stdin
Stdin binding. See StdinOptions.
ts
stdin?: StdinOptions;valueHint
Help placeholder label ('url', 'path', …).
ts
valueHint?: string;variadic
Whether this arg consumes all remaining positionals.
ts
variadic?: boolean;