https://github.com/tidbcloud/tidbcloud-cli
The CLI for TiDB Cloud
https://github.com/tidbcloud/tidbcloud-cli
cli go mysql serverless tidb tidbcloud
Last synced: 5 months ago
JSON representation
The CLI for TiDB Cloud
- Host: GitHub
- URL: https://github.com/tidbcloud/tidbcloud-cli
- Owner: tidbcloud
- License: apache-2.0
- Created: 2022-11-04T04:11:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T03:30:45.000Z (9 months ago)
- Last Synced: 2025-04-10T04:32:27.344Z (9 months ago)
- Topics: cli, go, mysql, serverless, tidb, tidbcloud
- Language: Go
- Homepage: https://tidb.cloud/
- Size: 1.84 MB
- Stars: 9
- Watchers: 14
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#tidb-cloud-cli)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [macOS and Linux](#macos-and-linux)
- [Installing via script](#installing-via-script)
- [Installing via TiUP](#installing-via-tiup)
- [Manually](#manually)
- [GitHub Action](#github-action)
- [Quick Start](#quick-start)
- [Config a profile](#config-a-profile)
- [Create a cluster](#create-a-cluster)
- [Documentation](#documentation)
- [Telemetry](#telemetry)
- [Roadmap](#roadmap)
## Installation
### macOS and Linux
#### Installing via script
```shell
curl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | sh
```
#### Installing via [TiUP](https://tiup.io/)
```shell
tiup install cloud
```
### Manually
Download the pre-compiled binaries from the [releases](https://github.com/tidbcloud/tidbcloud-cli/releases/latest) page and copy to the desired location.
### GitHub Action
To set up `ticloud` in GitHub Action, use [`setup-tidbcloud-cli`](https://github.com/tidbcloud/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](https://tidbcloud.com/).
### Config a profile
Config a profile with your TiDB Cloud [API key](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management) or log in via OAuth.
```shell
ticloud config create
# via TiUP
tiup cloud config create
# via OAuth
ticloud auth login
```
> :information_source: The config name **MUST NOT** contain '.'
### Create a cluster
```shell
ticloud serverless create
# via TiUP
tiup cloud serverless create
```
## Documentation
Please check the CLI help for more information.
## Telemetry
See [here](/docs/telemetry.md)
## 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 connecting in shell command without SQL user.