Define optional and variadic arguments
Use [OptionalArgument] when a positional value can be omitted and [VariadicArgument] when a command accepts multiple positional values.
Optional arguments
Declare an optional positional argument with its position:
public sealed partial record CopyParameters
{
[Argument(0)]
public required string Source { get; init; }
[OptionalArgument(1)]
public string? Destination { get; init; }
}
Both forms are valid:
copy input.txt output.txt
copy input.txt
Without a configured default, an omitted optional argument is null for nullable types.
Variadic arguments
Declare a variadic argument with [VariadicArgument]:
public sealed partial record TagParameters
{
[VariadicArgument(0, MinimumCount = 1)]
public required string[] Tags { get; init; }
}
MinimumCount = 1 requires at least one value. Use MaximumCount to set an upper bound:
[VariadicArgument(0, MinimumCount = 1, MaximumCount = 3)]
public required string[] Tags { get; init; }
A variadic argument accepts zero values by default:
[VariadicArgument(0)]
public string[] Values { get; set; } = [];
Errors
Omitting a required variadic value, supplying too many values, or omitting a required positional argument produces a structured command-line error and returns exit code 2 by default.