全局选项
全局选项对每条 tcb 命令生效,顺序无关。
选项列表
| 选项 | 说明 |
|---|---|
-h, --help | 查看当前命令的帮助信息 |
-e, --env-id <envId> | 环境 ID。省略时读配置文件的 envId,再省略则交互选择 |
-r, --region <region> | 地域,见地域 |
--json | 以 JSON 输出结果,见 JSON 输出 |
-y, --yes | 跳过所有确认提示,对询问取默认值 |
--verbose | 输出错误栈、API 请求参数与中间步骤日志 |
--cwd <path>/--workdir <path> | 项目目录,见项目目录 |
--config-file <path> | 配置文件路径,相对当前目录解析 |
--mode <mode> | 加载 .env 的环境模式,如 development、production |
地域
-r / --region 需用完整地域标识,不支持简写。
| 地域 | 标识 | 说明 |
|---|---|---|
| 上海 | ap-shanghai | 国内站默认 |
| 新加坡 | ap-singapore | 国际站默认 |
| 广州 | ap-guangzhou | 按白名单提供 |
ap-beijing 暂不提供。
默认地域随站点变化,站点由本机 isIntl 决定,切换方式见国际站登录。不确定当前地域时运行 tcb env list,输出末尾会提示。
也可以在 cloudbaserc.json 里写 region 字段,省去每次传参:
{
"envId": "your-env-id",
"region": "ap-singapore"
}
JSON 输出
| 流 | 内容 |
|---|---|
stdout | 只有可解析的 JSON,可直接 JSON.parse / jq |
stderr | 人类可读日志(info / success / warn / error / debug,含进度提示) |
错误也以 JSON 输出到 stdout:
{
"error": {
"code": "FUNCTION_NOT_FOUND",
"message": "函数 app 不存在",
"exit_code": 4
}
}
项目目录
--cwd / --workdir 自 v3.8.8 起提供,两者等价,同时指定时以 --cwd 为准。
| 内容 | 是否受项目目录影响 |
|---|---|
| 配置文件查找 | 是。只在项目目录查找,不向上级目录回溯,候选见配置文件查找 |
| 配置内的相对路径 | 是。functionRoot、functions[].dir、app.root、hosting、database.migrations、集成配置的 @file |
.env 与 --mode | 是。相对项目目录解析 |
| 凭证与配置写回 | 是。从项目目录读取凭证,cloudbaserc.json 写回项目目录 |
| 命令行传入的路径 | 否。--config-file、fn deploy --dir、fn invoke @file、hosting deploy <localPath>、cloudrun --source / --targetPath、db --dir、config pull --dir 一律相对当前目录 |
--cwd 缺值、路径不存在或不是目录时返回 INVALID_PARAM(退出码 3),--help 不做校验。
常见组合
# 无人值守 + 结构化输出
tcb fn list --yes --json -e my-env-id
# 排查部署失败
tcb fn deploy app --verbose -e my-env-id
# monorepo 中在仓库根目录操作子项目
tcb fn deploy --cwd apps/shop -e my-env-id
说明
--env-id与旧参数--envId等价,新版统一写--env-id- 环境不在默认地域(上海)时,CLI 提示切换地域并自动重试
--help输出的命令签名来自 CLI 本身,AI 生成命令前先读它可减少幻觉