ticloud config create

September 2, 2024 ยท View on GitHub

Create a user profile to store user profile settings:

ticloud config create [flags]

Note:

Before creating a user profile, you need to create a TiDB Cloud API Key.

Examples

Create a user profile in interactive mode:

ticloud config create

Create a user profile in non-interactive mode:

ticloud config create --profile-name <profile-name> --public-key <public-key> --private-key <private-key>

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
-h, --helpShows help information for this command.NoWorks in both non-interactive and interactive modes.
--private-key stringSpecifies the private key of the TiDB Cloud API.YesOnly works in non-interactive mode.
--profile-name stringSpecifies the name of the profile (which must not contain .).YesOnly works in non-interactive mode.
--public-key stringSpecifies the public key of the TiDB Cloud API.YesOnly 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.