Skip to content

Command

This item sets the completion candidates for each command.

The complete configuration items are as follows.

The overall structure of the Command is shown below.

description: command description.
alias: cmd-alias
arguments:
  1: {{ Argument }}
  --help: {{ Argument }}
  "*": {{ Argument }}
Property Required Type Description
description str | None command description.
alias str | list[str] | None command alias.
arguments dict[str | int, Argument] command arguments.

The following 3 types of arguments keys are available.

Examples Description
1, 2 Positional argument.
"--help",
"-v"
Keyword argument.
"*" Wildcard argument (The same rule applies to all positions not specified in the positional argument).
description: command description.
alias: cmd-alias
arguments:
  --verbose: {{ Argument }}
  --help: {{ Argument }}
subcommands:
  list: {{ Command }}
  run: {{ Command }}
Property Required Type Description
description str | None command description.
alias str | list[str] | None command alias.
arguments dict[str | int, Argument] command arguments.
subcommands dict[str, Command] Subcommands.

The following 3 types of arguments keys are available.

Examples Description
"--help", "-v" Keyword argument.
type: delegate
description: command description.
aliad: cmd-alias
target: aws
Property Required Type Description
type Literal["delegate"] command type.
description str | None command description.
alias str | list[str] | None command alias.
target str | list[str] delegate target.