TiDB Cloud CLI

The ticloud command line tool brings deploy cluster requests, and other TiDB Cloud concepts to your fingertips.

Table of Contents

• TiDB Cloud CLI
  • Table of Contents
  • Installation
    • macOS and Linux
      • Installing via script
      • Installing via TiUP
    • Manually
    • GitHub Action
  • Quick Start
    • Config a profile
    • Create a cluster
  • Documentation
  • Telemetry
  • Roadmap

Installation

macOS and Linux

Installing via script

curl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | sh

Installing via TiUP

tiup install cloud

Manually

Download the pre-compiled binaries from the releases page and copy to the desired location.

GitHub Action

To set up ticloud in GitHub Action, use setup-tidbcloud-cli.

Quick Start

In order to use the ticloud CLI, you need to have a TiDB Cloud account. If you don't have one, you can sign up for a free trial here.

Config a profile

Config a profile with your TiDB Cloud API key or log in via OAuth.

ticloud config create

# via TiUP
tiup cloud config create

# via OAuth
ticloud auth login

ℹ️ The config name MUST NOT contain '.'

Create a cluster

ticloud serverless create

# via TiUP
tiup cloud serverless create

Documentation

Please check the CLI help for more information.

Telemetry

See here

Roadmap

There are many features we want to add to the CLI.

• CLI supports generating demo code for using TiDB Cloud cluster.
• CLI supports managing the dedicated cluster.
• CLI supports backing up and restoring the TiDB Cloud cluster.
• CLI supports importing/exporting to external cloud storages.