Header menu logo Argu

ArgumentCaseInfo Type

Union argument metadata

Record fields

Record Field Description

AppSettingsCSV

Full Usage: AppSettingsCSV

Field type: Lazy<bool>

If specified, multiple parameters can be added in AppSettings in CSV form.

Field type: Lazy<bool>

AppSettingsName

Full Usage: AppSettingsName

Field type: Lazy<string option>

name used in AppSettings

Field type: Lazy<string option>

AppSettingsSeparators

Full Usage: AppSettingsSeparators

Field type: string list

AppSettings parameter separator

Field type: string list

AppSettingsSplitOptions

Full Usage: AppSettingsSplitOptions

Field type: StringSplitOptions

AppSettings parameter split options

Field type: StringSplitOptions

ArgumentType

Full Usage: ArgumentType

Field type: ArgumentType

Type of argument parser

Field type: ArgumentType

CliPosition

Full Usage: CliPosition

Field type: Lazy<CliPosition>

Mandated Cli position for the argument

Field type: Lazy<CliPosition>

CommandLineNames

Full Usage: CommandLineNames

Field type: Lazy<string list>

head element denotes primary command line arg

Field type: Lazy<string list>

CustomAssignmentSeparator

Full Usage: CustomAssignmentSeparator

Field type: Lazy<CustomAssignmentSeparator option>

Separator token used for EqualsAssignment syntax; e.g. '=' forces '--param=arg' syntax

Field type: Lazy<CustomAssignmentSeparator option>

Description

Full Usage: Description

Field type: Lazy<string>

Description of the parameter

Field type: Lazy<string>

GatherAllSources

Full Usage: GatherAllSources

Field type: Lazy<bool>

Combine AppSettings with CLI inputs

Field type: Lazy<bool>

IsGatherUnrecognized

Full Usage: IsGatherUnrecognized

Field type: Lazy<bool>

Declares that the parameter should gather any unrecognized CLI params

Field type: Lazy<bool>

IsHidden

Full Usage: IsHidden

Field type: Lazy<bool>

Hide from Usage

Field type: Lazy<bool>

IsMainCommand

Full Usage: IsMainCommand

Field type: bool

Specifies that this argument is the main CLI command

Field type: bool

IsMandatory

Full Usage: IsMandatory

Field type: Lazy<bool>

Fails if no argument of this type is specified

Field type: Lazy<bool>

IsRest

Full Usage: IsRest

Field type: Lazy<bool>

If specified, should consume remaining tokens from the CLI

Field type: Lazy<bool>

IsUnique

Full Usage: IsUnique

Field type: Lazy<bool>

Specifies that argument should be specified at most once in CLI

Field type: Lazy<bool>

Name

Full Usage: Name

Field type: Lazy<string>

Human readable name identifier

Field type: Lazy<string>

UnionCaseInfo

Full Usage: UnionCaseInfo

Field type: UnionCaseInfo

Union case reflection identifier

Field type: UnionCaseInfo

Type something to start searching.