TiDB Cloud CLI 快速入门

TiDB Cloud 提供命令行界面（CLI）ticloud，让你可以通过几行命令在终端中与 TiDB Cloud 交互。例如，你可以使用 ticloud 轻松执行以下操作：

创建、删除和列出你的集群。
向集群导入数据。
从集群导出数据。

注意

TiDB Cloud CLI 目前处于 beta 阶段。

开始之前

拥有 TiDB Cloud 账户。如果没有，请注册免费试用。

安装

macOS/Linux
Windows

对于 macOS 或 Linux，你可以使用以下任一方法安装 ticloud：

通过脚本安装（推荐）

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

通过 TiUP 安装
```
tiup install cloud
```
手动安装
从发布页面下载预编译的二进制文件，并将其复制到所需的安装位置。
在 GitHub Actions 中安装
要在 GitHub Action 中设置 ticloud，请使用 setup-tidbcloud-cli。

如果你没有 MySQL 命令行客户端，请安装它。你可以通过包管理器安装：

基于 Debian 的发行版：
```
sudo apt-get install mysql-client
```
基于 RPM 的发行版：
```
sudo yum install mysql
```
macOS：
```
brew install mysql-client
```

对于 Windows，你可以使用以下任一方法安装 ticloud：

手动安装
从发布页面下载预编译的二进制文件，并将其复制到所需的安装位置。
在 GitHub Actions 中安装
要在 GitHub Actions 中设置 ticloud，请使用 setup-tidbcloud-cli。

如果你没有 MySQL 命令行客户端，请安装它。你可以参考 MySQL Installer for Windows 中的安装说明。要在 Windows 上启动 ticloud connect，你需要将包含 mysql.exe 的目录添加到 PATH 环境变量中。

快速入门

TiDB Cloud Serverless 是开始使用 TiDB Cloud 的最佳方式。在本节中，你将学习如何使用 TiDB Cloud CLI 创建 TiDB Cloud Serverless 集群。

创建用户配置文件或登录 TiDB Cloud

在使用 TiDB Cloud CLI 创建集群之前，你需要创建用户配置文件或登录 TiDB Cloud。

使用你的 TiDB Cloud API 密钥创建用户配置文件：
```
ticloud config create
```
警告
配置文件名称不能包含 .。
通过身份验证登录 TiDB Cloud：
```
ticloud auth login
```
登录成功后，OAuth 令牌将分配给当前配置文件。如果不存在配置文件，令牌将分配给名为 default 的配置文件。

注意

在上述两种方法中，TiDB Cloud API 密钥优先于 OAuth 令牌。如果两者都可用，将使用 API 密钥。

创建 TiDB Cloud Serverless 集群

要创建 TiDB Cloud Serverless 集群，请输入以下命令，然后按照 CLI 提示提供所需信息：

ticloud serverless create

使用 TiDB Cloud CLI

查看所有可用命令：

ticloud --help

验证你是否使用最新版本：

ticloud version

如果不是，请更新到最新版本：

ticloud update

通过 TiUP 使用 TiDB Cloud CLI

TiDB Cloud CLI 也可以通过 TiUP 使用，组件名称为 cloud。

查看所有可用命令：

tiup cloud --help

使用 tiup cloud <command> 运行命令。例如：

tiup cloud serverless create

通过 TiUP 更新到最新版本：

tiup update cloud

下一步

查看 CLI 参考以探索 TiDB Cloud CLI 的更多功能。

反馈

如果你对 TiDB Cloud CLI 有任何问题或建议，欢迎创建议题。同时，我们也欢迎任何贡献。