TiDBTiDB Docs Dash 2024

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

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-keyThe public key of the TiDB Cloud APIYes
private-keyThe private key of the TiDB Cloud APIYes
api-urlThe 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 -P flag 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

FlagDescription
-h, --helpHelp 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.

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.