概述
CloudBase CLI 是云开发官方提供的命令行工具(
tcb),用于在终端中管理和部署云开发资源。V3 版本包含 15 个顶层命令模块,覆盖从环境创建到项目上线的完整流程,支持结构化输出,适用于手动操作与 CI/CD 自动化场景。安装
npm i -g @cloudbase/cli
也可通过 yarn 或 pnpm 安装:
yarn global add @cloudbase/clipnpm add -g @cloudbase/cli
安装完成后,执行
tcb --version 验证安装。登录认证
控制台授权(推荐):
tcb login,自动打开浏览器完成授权云 API 密钥授权:
tcb login --key,按提示输入 SecretId 和 SecretKeyCI 环境登录:
tcb login --apiKeyId xxx --apiKey xxx临时密钥登录:
tcb login --apiKeyId xxx --apiKey xxx --token xxx功能模块
环境管理
管理云开发环境的完整生命周期,包括创建、切换、续费、销毁及资源用量查询。
tcb env list — 查看环境列表tcb env use <envId> — 设置默认环境tcb env create — 创建环境tcb env info — 查看环境详情tcb env usage — 查询资源用量tcb env modify — 修改环境配置tcb env renew — 环境续费tcb env delete — 销毁环境云函数
部署和管理云函数,支持普通云函数和 HTTP 云函数。
tcb fn deploy [name] — 部署云函数tcb fn deploy --httpFn — 部署为 HTTP 云函数tcb fn deploy --all — 部署全部云函数tcb fn list — 查看已部署的函数列表数据库
管理文档型数据库和 MySQL 数据库,支持数据模型、索引和原生命令执行。
tcb db model list — 查看数据模型列表tcb db model pull — 拉取数据模型到本地tcb db model push — 推送数据模型到云端tcb db nosql execute — 执行 NoSQL 命令tcb db mysql execute — 执行 MySQL 语句云存储
管理云端文件,支持上传、下载、删除、复制和搜索。
tcb storage upload — 上传文件tcb storage download — 下载文件tcb storage rm — 删除文件tcb storage cp — 复制或移动文件tcb storage list — 查看文件列表tcb storage search — 搜索文件静态网站托管
部署和管理静态网站,适合纯静态内容的上传与同步。如项目包含构建步骤(React/Vue 等),建议使用
tcb app deploy。tcb hosting deploy — 部署静态文件tcb hosting list — 查看文件列表tcb hosting delete — 删除文件云应用
管理前端应用部署,支持自动构建。
tcb app deploy — 部署云应用tcb app list — 获取部署云应用列表tcb app info — 获取云应用部署详情tcb app versions list — 查看应用版本历史列表tcb app versions detail — 查看应用指定版本的详细信息,默认显示最新版本tcb app delete — 删除云应用云托管
管理容器化部署的后端服务,支持函数型和容器型两种模式。
tcb cloudrun init — 初始化项目tcb cloudrun deploy — 部署服务tcb cloudrun list — 查看服务列表tcb cloudrun delete — 删除服务tcb cloudrun traffic — 灰度流量分配与回滚HTTP 访问服务
管理 HTTP 访问服务的路由规则、自定义域名和安全域名(CORS)配置。
tcb routes add — 添加路由规则tcb routes list — 查看路由列表tcb domains add — 绑定自定义域名tcb domains list — 查看域名列表tcb cors add — 添加安全域名tcb cors list — 查看安全域名列表权限管理
统一管理数据库集合、存储桶、SQL 表、云函数的访问权限。
tcb permission set — 设置资源权限tcb permission list — 查看权限规则用户与角色
管理终端用户及角色。
tcb user list — 查看用户列表tcb user create — 创建用户tcb role list — 查看角色列表tcb role update — 更新角色日志检索
统一检索云函数、云托管、数据库等资源的运行日志。
tcb logs search — 搜索日志AI 智能体
管理 AI Agent 相关能力。
tcb agent — AI Agent 管理文档检索
在终端内直接检索和阅读 CloudBase 官方文档。
tcb docs list — 列出所有文档模块tcb docs read — 读取指定文档tcb docs search — 关键词搜索文档通用 API 调用
在命令行中直接调用腾讯云 API,自动处理鉴权。
tcb api <service> <action> — 调用腾讯云 API配置文件
CLI 使用项目根目录下的
cloudbaserc.json 作为配置文件,用于定义环境、云函数、部署参数等。可通过 tcb init 初始化生成,也可通过 --config-file 指定自定义路径。环境 ID 解析优先级:命令行
--env-id > 项目 cloudbaserc.json > tcb env use 全局设置。全局选项
以下选项适用于所有命令:
--help — 查看命令帮助--env-id <envId> — 指定环境 ID--region <region> — 指定地域--json — 以 JSON 格式输出,便于脚本解析--yes — 跳过确认提示,适用于 CI/CD--verbose — 打印详细运行信息--config-file <path> — 指定配置文件路径注意事项
V3 命令统一为空格分隔(如
tcb fn deploy),旧版冒号格式(如 tcb functions:deploy)仍兼容但不推荐子账号需在访问管理控制台关联
QcloudAccessForTCBRole 等预设策略后方可使用如终端无法直接访问公网,可通过
HTTP_PROXY 环境变量配置代理从旧版本升级请参考:从 v1/v2 升级到 v3