用途:通过 ticloud CLI 完成 TiDB Cloud Serverless(现更名为 TiDB X,用户说法中的“实例”等同于“集群”)的开通与生命周期管理,包括集群和分支的创建、删除、列出,以及查询区域、项目等。
主要能力:先做环境准备与认证,再按 项目→集群→分支 层级执行 CRUD。安装:curl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | sh,随后用 command -v ticloud 验证。认证先执行 ticloud auth whoami,未登录则运行 ticloud auth login --insecure-storage 并完成浏览器流程后复查。列表输出使用终端友好 ASCII 表格(+, -, | 边框,固定列宽、左对齐,不用 Unicode 框线字符)。创建集群前依次列出区域与项目并让用户选择,再确认集群显示名;非交互环境可用 ticloud serverless list -p <project-id> -o json 后自行渲染表格。删除操作需用户显式确认。
使用方式:按顺序完成安装→登录→ticloud auth whoami 验证;创建、删除、查询的具体命令模式见 references/ticloud.md。若出现网络/DNS 问题(如无法访问 iam.tidbapi.com),需为环境开放网络或在本地执行后提供输出;持续报错可参考 https://docs.pingcap.com/tidbcloud/get-started-with-cli/。耗时操作等待最多 60 秒再返回;创建集群命令不要重复执行。
适用场景:需要以命令行方式批量或规范化开通 TiDB X 集群、查看集群与分支、以及做删除清理的智能体工作流。
限制:不要通过 CLI 创建、更新或删除 SQL 用户;.env 下载、SQL 用户管理与数据库创建应使用 TiDB Cloud 控制台,控制台链接形如 https://tidbcloud.com/clusters/<cluster-id>/overview?orgId=<org-id>&projectId=<project-id>。切勿读取或展示已保存密码(不要 cat .env)。删除前必须显式确认;任何操作前先执行 ticloud auth whoami。收费、价格与配额等资料暂未提供。