Skip to main content

Get information about CLI

Experimental: This API is not stable and might be subject of change.
Get information about CLI

Responses

name, information and help of available commands.


Schema
  • commands object[]

    All available commands

  • name string

    The name of the CLI command.

  • args object
    oneOf

  • name string

    The name of the CLI command argument.

  • expects_value boolean

    Indicates, if the argument expects a value.

  • possible_values string[]

    Possible values for this argument.

  • can_occur_multiple_times boolean

    Indicates, if the argument can occur multiple times.

  • value_hint string

    Hint for the value of this argument.

  • help_text string

    Help text of the CLI command argument.

  • info string

    Short description.

  • help string

    Help text of the CLI command.

  • source boolean

    Indicates, if the command is allowed in source position (first command in a chain).

  • replacements object

    All available replacements with current value

  • property name* string
  • alias_names object

    All available aliases

  • property name* string
  • alias_templates object[]

    All available alias template name.

  • name string

    The name of the CLI command.

  • args object
    oneOf

  • name string

    The name of the CLI command argument.

  • expects_value boolean

    Indicates, if the argument expects a value.

  • possible_values string[]

    Possible values for this argument.

  • can_occur_multiple_times boolean

    Indicates, if the argument can occur multiple times.

  • value_hint string

    Hint for the value of this argument.

  • help_text string

    Help text of the CLI command argument.

  • info string

    Short description.

  • help string

    Help text of the CLI command.

  • source boolean

    Indicates, if the command is allowed in source position (first command in a chain).

Loading...