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.

PropertiesDescriptionRequired
public-keySpecifies the public key of the TiDB Cloud API.Yes
private-keySpecifies the private key of the TiDB Cloud API.Yes
api-urlSpecifies the base API URL of TiDB Cloud (https://api.tidbcloud.com by default).No

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

FlagDescription
-h, --helpShows help information for this command.

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?