ticloud config set
Configure the properties for the active user profile:
ticloud config set <property-name> <value> [flags]
The properties that can be configured include public-key, private-key, and api-url.
| Properties | Description | Required |
|---|---|---|
| public-key | Specifies the public key of the TiDB Cloud API. | Yes |
| private-key | Specifies the private key of the TiDB Cloud API. | Yes |
| api-url | Specifies the base API URL of TiDB Cloud (https://api.tidbcloud.com by default). | No |
Notes:
If you want to configure properties for a specific user profile, you can add the
-Pflag and specify the target user profile name in the command.
Examples
Set the value of the public-key for the active profile:
ticloud config set public-key <public-key>
Set the value of the public-key for a specific profile test:
ticloud config set public-key <public-key> -P test
Set the API host:
ticloud config set api-url https://api.tidbcloud.com
Flags
| Flag | Description |
|---|---|
| -h, --help | Shows help information for this command. |
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. |
| -D, --debug | Enables debug mode. | 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.