ticloud branch list
List all branches for a cluster:
ticloud branch list <cluster-id> [flags]
Or use the following alias command:
ticloud branch ls <cluster-id> [flags]
Examples
List all branches for a cluster (interactive mode):
ticloud branch list
List all branches for a specified cluster (non-interactive mode):
ticloud branch list <cluster-id>
List all branches for a specified cluster in the JSON format:
ticloud branch list <cluster-id> -o json
Arguments
The branch list
command has the following arguments:
Argument Index | Description | Required | Note |
---|---|---|---|
<cluster-id> | The cluster ID of the branches which will be listed | Yes | Only works in non-interactive mode. |
Flags
In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.
Flag | Description | Required | Note |
---|---|---|---|
-h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. |
-o, --output string | Output format (human by default). Valid values are human or json . To get a complete result, use the json format. | No | Works in both non-interactive and interactive modes. |
Inherited flags
Flag | Description | Required | Note |
---|---|---|---|
--no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. |
-P, --profile string | Specifies the active user profile used in this command. | No | Works in both non-interactive and interactive modes. |
Feedback
If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an issue. Also, we welcome any contributions.