vapi metadata cli command: info
The
info
structure contains information about a command. It includes the identity of the command, a description, information about the service and operation that implement the command, and CLI-specific information for the command.Representation:
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
identity | identity | Basic command identity.
|
identity.path | string | The dot-separated path of the namespace containing the command in the CLI command tree.
|
identity.name | string | Name of the command.
|
description | string | The text description displayed to the user in help output.
|
service_id | string | The service identifier that contains the operations for this CLI command. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: |
operation_id | string | The operation identifier corresponding to this CLI command. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: |
options | option_info[] | The input for this command.
|
options[].long_option | string | The long option name of the parameter as used by the user.
|
output_field_list | output_info[] | List of output structure name and output field info.
|
Optional | ||
options[].short_option | string | The single character value option name. Optional. If not present, there's no single character option for the parameter. |
formatter | string | The formatter to use when displaying the output of this command. Optional. If not present, client can choose a default output formatter. |