Argument

interface Argument

A positional parameter to a command.

Arguments can take any number of values.

Properties

Optional set of strings to use when the user invokes shell autocomplete on a value for this argument.

Extra information about this argument to pass to the help formatter.

abstract val name: String

The metavar for this argument.

abstract val nvalues: Int

The number of values that this argument takes.

If true, an error will be thrown if this argument is not given on the command line.

abstract fun finalize(context: Context, values: List<String>)

Called after this command's argv is parsed to transform and store the argument's value.

The description of this argument.

Information about this argument for the help output.

abstract fun postValidate(context: Context)

Called after all of a command's parameters have been finalized to perform validation of the final value.