Get information about CLI​
Experimental: This API is not stable and might be subject of change.
Get information about CLI
- 200
name, information and help of available commands.
- application/json
- Schema
- Example (from schema)
Schema
commands object[]
All available commands
name stringThe name of the CLI command.
args object
oneOf- MOD1
- MOD2
name stringThe name of the CLI command argument.
expects_value booleanIndicates, if the argument expects a value.
possible_values string[]Possible values for this argument.
can_occur_multiple_times booleanIndicates, if the argument can occur multiple times.
value_hint stringHint for the value of this argument.
help_text stringHelp text of the CLI command argument.
name stringThe name of the CLI command argument.
expects_value booleanIndicates, if the argument expects a value.
possible_values string[]Possible values for this argument.
can_occur_multiple_times booleanIndicates, if the argument can occur multiple times.
value_hint stringHint for the value of this argument.
help_text stringHelp text of the CLI command argument.
info stringShort description.
help stringHelp text of the CLI command.
source booleanIndicates, if the command is allowed in source position (first command in a chain).
replacements object
All available replacements with current value
property name*
stringalias_names object
All available aliases
property name*
stringalias_templates object[]
All available alias template name.
name stringThe name of the CLI command.
args object
oneOf- MOD1
- MOD2
name stringThe name of the CLI command argument.
expects_value booleanIndicates, if the argument expects a value.
possible_values string[]Possible values for this argument.
can_occur_multiple_times booleanIndicates, if the argument can occur multiple times.
value_hint stringHint for the value of this argument.
help_text stringHelp text of the CLI command argument.
name stringThe name of the CLI command argument.
expects_value booleanIndicates, if the argument expects a value.
possible_values string[]Possible values for this argument.
can_occur_multiple_times booleanIndicates, if the argument can occur multiple times.
value_hint stringHint for the value of this argument.
help_text stringHelp text of the CLI command argument.
info stringShort description.
help stringHelp text of the CLI command.
source booleanIndicates, if the command is allowed in source position (first command in a chain).
{
"commands": [
{
"name": "string",
"args": [
{
"name": "string",
"expects_value": true,
"possible_values": [
"string"
],
"can_occur_multiple_times": true,
"value_hint": "string",
"help_text": "string"
}
],
"info": "string",
"help": "string",
"source": true
}
],
"replacements": {},
"alias_names": {},
"alias_templates": [
{
"name": "string",
"args": [
{
"name": "string",
"expects_value": true,
"possible_values": [
"string"
],
"can_occur_multiple_times": true,
"value_hint": "string",
"help_text": "string"
}
],
"info": "string",
"help": "string",
"source": true
}
]
}