The following table describes the command-line format conventions used in this document.
| Format | Description |
|---|---|
zbs-meta migrate list |
The command without parameters. Enter it as is. For example:
|
<parameter_value> |
Angle brackets indicate required parameters. Replace them with actual values. For example: Syntax: Input: |
| |
The vertical bar separates multiple mutually exclusive optional parameters. |
{} |
Curly braces indicate that there are multiple parameters, but only one is required. For example:
|
[] |
Square brackets indicate optional parameters, which can be empty. For example:
|
Most commands support the following common parameters, which must be specified before the subcommand.
| Parameter | Description |
|---|---|
-h, --help | Displays help information for the command, including usage and supported subcommands. |
-v | Outputs detailed execution information and error messages (verbose mode). |
-f <format> | Specifies the output format. Supported values are json, table, and dict. For details, refer to Output formats. |
The output format of a command can be specified using the -f parameter. The following formats are supported:
json: Outputs in JSON format. It is suitable for parsing by automation scripts. If you plan to write automation scripts or test programs to parse command output, using JSON is strongly recommended. JSON output maintains forward compatibility, ensuring scripts work properly after version upgrades.
table: Outputs in a table format, which is the default textual format, designed for human readability. Text output may be adjusted or optimized in future versions, so forward compatibility is not guaranteed. Using this format in test scripts may cause failures after upgrades.
dict: Outputs in a dictionary format.
