TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

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 IndexDescriptionRequiredNote
<cluster-id>The cluster ID of the branches which will be listedYesOnly 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.

FlagDescriptionRequiredNote
-h, --helpHelp information for this commandNoWorks in both non-interactive and interactive modes.
-o, --output stringOutput format (human by default). Valid values are human or json. To get a complete result, use the json format.NoWorks in both non-interactive and interactive modes.

Inherited flags

FlagDescriptionRequiredNote
--no-colorDisables color in output.NoOnly works in non-interactive mode. In interactive mode, disabling color might not work with some UI components.
-P, --profile stringSpecifies the active user profile used in this command.NoWorks 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.

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.