ti configure

Configures a local TiDB Cloud CLI profile. Without flags, this is the only interactive TiDB Cloud CLI command.

Syntax

ti configure
  [--help]
  [--non-interactive]
  [--region-code <string>]
  [--tidb-cloud-private-key <string>]
  [--tidb-cloud-public-key <string>]
  [--version]

Options

• --help: Display help information.
• --non-interactive: Use this option to avoid being prompted for configuration values. You must provide at least three configuration values (--tidb-cloud-public-key, --tidb-cloud-private-key, and --region-code) when using this option. This is useful when running ti in a script or automated environment.
• --region-code <string>: Default region code, for example aws-us-east-1 or aws-ap-southeast-1.
• --tidb-cloud-private-key <string>: TiDB Cloud API private key.
• --tidb-cloud-public-key <string>: TiDB Cloud API public key.
• --version: Display version information.

For options shared by all commands, see Global options.

Examples

• Configure ti interactively:

  # Enter the default region code and TiDB Cloud API keys when prompted.
  ti configure
  

• Configure ti for automation:

  # Supply all required values without interactive prompts.
  TI_REGION_CODE="aws-us-east-1" \
  TIDB_CLOUD_PUBLIC_KEY="<public-key>" \
  TIDB_CLOUD_PRIVATE_KEY="<private-key>" \
  ti configure --profile ci --non-interactive
  

Related documentation

• Install, Configure, and Update TiDB Cloud CLI