BooleanArgDefinition
Definition of a boolean arg.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/schema/arg.ts - Source link:
src/core/schema/arg.ts:603
Signatures
interface BooleanArgDefinition extends ArgDefinitionBase {}Members
Properties
kind
Kind discriminator.
kind: "boolean";completion
Callback used to complete this input's values.
completion?: CompletionHandler | undefined;presence
Presence state.
presence?: ArgPresence | undefined;variadic
Whether this arg consumes all remaining positionals.
variadic?: boolean | undefined;stdin
Stdin binding. See StdinOptions.
stdin?: StdinOptions | undefined;defaultValue
Runtime default value.
defaultValue?: unknown;defaultDescription
Human-readable replacement for the default value in help, or false to omit the default annotation.
defaultDescription?: string | false | undefined;sensitive
Whether values from this input must be kept out of user-facing projections.
sensitive?: boolean | undefined;description
Human-readable description for help text.
description?: HelpDescription | undefined;group
Named section in command help.
group?: string | undefined;envVar
Environment variable name for env resolution.
envVar?: string | undefined;envIndexed
Indexed environment family read as the env source, in place of ArgDefinitionBase.envVar. Requires a variadic arg, or a custom arg without a string parse function.
envIndexed?: IndexedEnvBinding | undefined;envAbsolute
Read the env source exactly as written, outside the CLI-wide namespace. Requires envVar or envIndexed.
envAbsolute?: boolean | undefined;envFromName
Derive envVar from the registered name.
envFromName?: boolean | undefined;configPath
Dotted config path for config resolution (e.g. 'deploy.region').
configPath?: string | undefined;prompt
Interactive prompt configuration.
prompt?: PromptConfig | undefined;valueHint
Help placeholder label ('url', 'path', …).
valueHint?: string | undefined;separator
CLI value separator each positional token is split on.
separator?: string | undefined;split
Env and stdin split policies.
split?: SourceSplitBinding | undefined;unique
Deduplicate the resolved values of a variadic arg.
unique?: boolean | undefined;standard
Standard Schema v1 validator applied to each resolved value.
standard?: StandardSchemaV1 | undefined;aggregateStandard
Standard Schema v1 validator applied to a completed collection.
aggregateStandard?: StandardSchemaV1 | undefined;deprecated
Deprecation marker. true deprecates without a message, a string carries the migration guidance.
deprecated?: string | true | undefined;