Get information about CLI
GET/cli/info
Get information about CLI
Responses​
- 200
name, information and help of available commands.
- application/json
- Schema
- Example (from schema)
Schema
Array [
- MOD1
- CLICommandArg
Array [
]
]
Array [
- MOD1
- CLICommandArg
Array [
]
]
commands
object[]
All available commands
The name of the CLI command.
args
object
oneOf
The name of the CLI command argument.
Indicates, if the argument expects a value.
Possible values for this argument.
Indicates, if the argument can occur multiple times.
Hint for the value of this argument.
Help text of the CLI command argument.
The name of the CLI command argument.
Indicates, if the argument expects a value.
Possible values for this argument.
Indicates, if the argument can occur multiple times.
Hint for the value of this argument.
Help text of the CLI command argument.
Short description.
Help text of the CLI command.
Indicates, if the command is allowed in source position (first command in a chain).
replacements
object
All available replacements with current value
alias_names
object
All available aliases
alias_templates
object[]
All available alias template name.
The name of the CLI command.
args
object
oneOf
The name of the CLI command argument.
Indicates, if the argument expects a value.
Possible values for this argument.
Indicates, if the argument can occur multiple times.
Hint for the value of this argument.
Help text of the CLI command argument.
The name of the CLI command argument.
Indicates, if the argument expects a value.
Possible values for this argument.
Indicates, if the argument can occur multiple times.
Hint for the value of this argument.
Help text of the CLI command argument.
Short description.
Help text of the CLI command.
Indicates, if the command is allowed in source position (first command in a chain).
{
"commands": [
{
"name": "string",
"args": [
null
],
"info": "string",
"help": "string",
"source": true
}
],
"replacements": {},
"alias_names": {},
"alias_templates": [
{
"name": "string",
"args": [
null
],
"info": "string",
"help": "string",
"source": true
}
]
}