ticloud serverless shell

Connect to a TiDB Cloud Serverless cluster:

ticloud serverless shell [flags]

Examples

Connect to a TiDB Cloud Serverless cluster in interactive mode:

ticloud serverless shell

Connect to a TiDB Cloud Serverless cluster with the default user in non-interactive mode:

ticloud serverless shell -c <cluster-id>

Connect to a TiDB Cloud Serverless cluster with the default user and password in non-interactive mode:

ticloud serverless shell -c <cluster-id> --password <password>

Connect to a TiDB Cloud Serverless cluster with a specific user and password in non-interactive mode:

ticloud connect -c <cluster-id> -u <user-name> --password <password>

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.YesOnly works in non-interactive mode.
-h, --helpShows help information for this command.NoWorks in both non-interactive and interactive modes.
--passwordSpecifies the password of the user.NoOnly works in non-interactive mode.
-u, --user stringSpecifies the user for login.NoOnly works in non-interactive mode.

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.

Was this page helpful?