ticloud serverless branch create

April 21, 2026 ยท View on GitHub

Create a branch for a {{{ .starter }}} or {{{ .essential }}} instance:

ticloud serverless branch create [flags]

Examples

Create a branch for a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode:

ticloud serverless branch create

Create a branch for a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode:

ticloud serverless branch create --cluster-id <cluster-id> --display-name <branch-name>

Create a branch from another branch with a specified timestamp in non-interactive mode:

ticloud serverless branch create --cluster-id <cluster-id> --display-name <branch-name> --parent-id <parent-branch-id> --parent-timestamp <parent-timestamp>

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
-c, --cluster-id stringSpecifies the ID of the cluster, in which the branch will be created.YesOnly works in non-interactive mode.
-n, --display-name stringSpecifies the name of the branch to be created.YesOnly works in non-interactive mode.
--parent-id stringSpecifies the ID of the branch parent. The default value is the cluster ID.NoOnly works in non-interactive mode.
--parent-timestamp stringSpecifies the timestamp of the parent branch in RFC3339 format, such as 2024-01-01T00:00:00Z. The default value is the current time.NoOnly works in non-interactive mode.
-h, --helpShows help information for this command.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.
-D, --debugEnables debug mode.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.