Defines an argument for a command. An <arg> tag must appear within the <signature> tag for a command.
<!-- Should appear within a <signature> tag --><arg name="who" help="Who you want to greet">
name | purpose | type | required? | default | choices |
---|---|---|---|---|---|
help |
Argument help text | text | No | ||
metavar |
Argument metavar (shown in the help) | text | No | ||
name |
Argument name (the variable when the command is execute) | text | No | ||
nargs |
Number of arguments to be consumed | text | No | ||
type |
Type of argument | text | No | "string" |
file float integer string |