Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.94 KB

ticloud-config-create.md

File metadata and controls

53 lines (37 loc) · 2.94 KB
title summary
ticloud config create
The reference of `ticloud config create`.

ticloud config create

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.

Flag Description Required Note
-h, --help Shows help information for this command. No Works in both non-interactive and interactive modes.
--private-key string Specifies the private key of the TiDB Cloud API. Yes Only works in non-interactive mode.
--profile-name string Specifies the name of the profile (which must not contain .). Yes Only works in non-interactive mode.
--public-key string Specifies the public key of the TiDB Cloud API. Yes Only works in non-interactive mode.

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.