TCB Harness

CloudBase CLI & SDK 速查（v3, 2026-04 更新）

CLI: npm i -g @cloudbase/cli → tcb

小程序: 内置微信/QQ小程序框架，无需安装

服务端: npm i @cloudbase/node-sdk（云函数/数据库/存储调用）

管理端: npm i @cloudbase/manager-node（资源创建/管理/配置）

文档: tcb docs search <关键词> 终端内直接检索官方文档

Full-lifecycle development harness for CloudBase (Tencent CloudBase) projects.

Platform Types

This harness manages three platform configurations:

| 类型 | 简称 | 前端 | 后台 | 认证 | |------|------|------|------|------| | 小程序 | MP | 微信小程序（TDesign Miniprogram） | 可选 CloudBase 云函数/云托管 | OPENID 静默 | | Web | Web | PC 浏览器应用（TDesign React） | CloudBase 云函数/云托管 | Web SDK Auth | | 移动端 | Mobile | 移动端 H5（TDesign Mobile React） | CloudBase 云函数/云托管 | Web SDK Auth | | 公众号 | OA | 微信公众号 H5（TDesign React + JSSDK） | CloudBase 云函数/云托管 | OAuth 2.0 | | 混合项目 | Hybrid | 小程序 + Web + 移动端 + 公众号任意组合 | 统一后台 | 各自平台认证 |

CloudBase CLI & SDK 完整参考

CloudBase CLI (`tcb`) — 安装与认证

npm i -g @cloudbase/cli          # 或 yarn global add / pnpm add -g
tcb --version                       # 验证安装

认证方式： | 方式 | 命令 | 适用场景 | |------|------|---------| | 控制台授权（推荐） | tcb login | 本地开发 | | 云 API 密钥 | tcb login --key | 服务器/CI | | CI 环境 | tcb login --apiKeyId xxx --apiKey xxx | 自动化流水线 | | 临时密钥 | tcb login --apiKeyId xxx --apiKey xxx --token xxx | 临时访问 |

全局选项： --env-id <envId> / --region <region> / --json / --yes / --verbose / --config-file <path>

环境 ID 优先级： 命令行 --env-id > cloudbaserc.json > tcb env use 全局设置

CloudBase CLI 命令速查（15 个模块）

1. 环境管理 `tcb env ...`

| 命令 | 说明 | |------|------| | 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 | 销毁环境 |

2. 云函数 `tcb fn ...`

| 命令 | 说明 | |------|------| | tcb fn deploy [name] | 部署云函数 | | tcb fn deploy --httpFn | 部署为 HTTP 云函数 | | tcb fn deploy --all | 部署全部云函数 | | tcb fn list | 查看已部署的函数列表 |

3. 数据库 `tcb db ...`

| 命令 | 说明 | |------|------| | tcb db model list | 查看数据模型列表 | | tcb db model pull | 拉取数据模型到本地 | | tcb db model push | 推送数据模型到云端 | | tcb db nosql execute | 执行 NoSQL 命令 | | tcb db mysql execute | 执行 MySQL 语句 |

4. 云存储 `tcb storage ...`

| 命令 | 说明 | |------|------| | tcb storage upload | 上传文件 | | tcb storage download | 下载文件 | | tcb storage rm | 删除文件 | | tcb storage cp | 复制或移动文件 | | tcb storage list | 查看文件列表 | | tcb storage search | 搜索文件 |

5. 静态网站托管 `tcb hosting ...`

| 命令 | 说明 | |------|------| | tcb hosting deploy | 部署静态文件 | | tcb hosting list | 查看文件列表 | | tcb hosting delete | 删除文件 |

⚠️ 如项目含构建步骤（React/Vue 等），建议使用 tcb app deploy（自动构建）

6. 云应用 `tcb app ...`

| 命令 | 说明 | |------|------| | tcb app deploy | 部署云应用（含自动构建） | | tcb app list | 获取部署云应用列表 | | tcb app info | 获取云应用部署详情 | | tcb app versions list | 查看应用版本历史 | | tcb app versions detail | 查看指定版本详情 | | tcb app delete | 删除云应用 |

7. 云托管 `tcb cloudrun ...`

| 命令 | 说明 | |------|------| | tcb cloudrun init | 初始化项目 | | tcb cloudrun deploy | 部署服务 | | tcb cloudrun list | 查看服务列表 | | tcb cloudrun delete | 删除服务 | | tcb cloudrun traffic | 灰度流量分配与回滚 |

8. HTTP 访问服务 `tcb routes / tcb domains / tcb cors ...`

| 命令 | 说明 | |------|------| | tcb routes add | 添加路由规则 | | tcb routes list | 查看路由列表 | | tcb domains add | 绑定自定义域名 | | tcb domains list | 查看域名列表 | | tcb cors add | 添加安全域名 | | tcb cors list | 查看安全域名列表 |

9. 权限管理 `tcb permission ...`

| 命令 | 说明 | |------|------| | tcb permission set | 设置资源权限 | | tcb permission list | 查看权限规则 |

10. 用户与角色 `tcb user / tcb role ...`

| 命令 | 说明 | |------|------| | tcb user list | 查看用户列表 | | tcb user create | 创建用户 | | tcb role list | 查看角色列表 | | tcb role update | 更新角色 |

11. 日志检索 `tcb logs ...`

| 命令 | 说明 | |------|------| | tcb logs search | 搜索日志（云函数/云托管/数据库等） |

12. AI 智能体 `tcb agent ...`

| 命令 | 说明 | |------|------| | tcb agent | AI Agent 管理 |

13. 文档检索 `tcb docs ...`

| 命令 | 说明 | |------|------| | tcb docs list | 列出所有文档模块 | | tcb docs read | 读取指定文档 | | tcb docs search | 关键词搜索文档 |

14. 通用 API `tcb api ...`

| 命令 | 说明 | |------|------| | tcb api <service> <action> | 直接调用腾讯云 API，自动处理鉴权 |

15. 配置文件

项目根目录 cloudbaserc.json 定义环境、云函数、部署参数
通过 tcb init 初始化生成，或 --config-file 指定自定义路径

CloudBase SDK 体系与选型

| SDK | 包名 | 用途 | 安装 | |-----|------|------|------| | 小程序端 | 内置（微信/QQ 小程序框架内置） | 在小程序中访问 CloudBase 服务 | 无需安装 | | Web 端 | tcb-js-sdk（历史）/ cloudbase-js-sdk | 浏览器端访问 CloudBase | CDN 或 npm | | 服务端 Node.js | @cloudbase/node-sdk | 云函数/云服务器中调用 CloudBase | npm i @cloudbase/node-sdk | | 管理端 Node.js | @cloudbase/manager-node | 资源创建/管理/配置（CI/CD） | npm i @cloudbase/manager-node |

服务端 SDK (`@cloudbase/node-sdk`) — 适用场景

在云函数内部或云服务器中使用，用于调用 CloudBase 服务：

// 初始化
const tcb = require('@cloudbase/node-sdk');
const app = tcb.init({ env: 'your-env-id' });

// 调用云函数
const res = await app.callFunction({ name: 'getList', data: { page: 1 } });

// 文件上传
await app.uploadFile({ cloudPath: 'xxx.jpg', filePath: './xxx.jpg' });

// 数据库操作
const db = app.database();
await db.collection('todos').add({ content: 'learn tcb', done: false });

// MySQL
const mysql = app.mysql();
await mysql.query('SELECT * FROM users WHERE id = ?', [1]);

主要模块： 初始化 / MySQL 数据库 / 文档型数据库 / 云函数 / 云存储

管理端 SDK (`@cloudbase/manager-node`) — 适用场景

在本地 CI/CD 或管理脚本中使用，用于创建/管理/配置云开发资源：

const { manager } = require('@cloudbase/manager-node');

// 初始化
const envId = 'your-env-id';

// 环境管理
const envInfo = await manager.env.getInfo(envId);

// 云函数管理
await manager.function.createFunction(envId, { name: 'myFn', code: '...' });
await manager.function.deployFunction(envId, { name: 'myFn' });

// 数据库管理
await manager.database.createCollection(envId, 'todos');
await manager.database.createIndex(envId, 'todos', { index: [], unique: false });

// 存储管理
await manager.storage.uploadFile(envId, localPath, cloudPath);

// 静态托管
await manager.hosting.uploadFile(envId, localFile, cloudPath);
await manager.hosting.getDeployInfo(envId);

// 安全规则
await manager.rule.setDatabaseRule(envId, collectionName, rules);
await manager.rule.setStorageRule(envId, rules);

// 安全来源
await manager.safeSource.addSafeSource(envId, 'https://example.com');

主要模块： 环境管理 / 云函数 / 数据库 / 文件存储 / 静态网站托管 / HTTP访问服务 / 安全规则 / 安全来源 / 公共接口

SDK 选型决策树

我要在哪里运行代码？
│
├─ 微信/QQ 小程序里
│    → 无需安装 SDK，wx.cloud 已内置
│    → 直接使用 wx.cloud.callFunction() / wx.cloud.database() 等
│
├─ 浏览器（Web/H5）里
│    → 安装 cloudbase-js-sdk
│    → 通过 Web Auth 完成身份认证
│    → 适合：TDesign React / 公众号 H5
│
├─ 云函数（腾讯云）里
│    → 安装 @cloudbase/node-sdk
│    → 已通过环境变量自动获取认证，无手动鉴权
│    → 适合：云函数内部调用数据库/存储/其他云函数
│
└─ 本地/CI/CD 管理脚本里
     → 安装 @cloudbase/manager-node
     → 需要通过 SecretId/SecretKey 或临时凭证鉴权
     → 适合：资源创建/删除/配置/自动化部署

CLI 与 SDK 的配合策略

| 场景 | 推荐方式 | 说明 | |------|---------|------| | 本地日常开发（云函数同步、静态托管） | tcb fn deploy / tcb hosting deploy | CLI 直接操作，快速迭代 | | 自动化流水线（CI/CD） | @cloudbase/manager-node | SDK 精确控制，适合 GitHub Actions | | 云函数内部调用其他云函数/数据库 | @cloudbase/node-sdk | 服务端自动认证，无需手动鉴权 | | 小程序调用后台 | wx.cloud（内置）| 无需安装，直接用 | | Web 应用调用后台 | cloudbase-js-sdk | 浏览器端带认证的 SDK | | 快速查询日志/诊断 | tcb logs search / tcb logs search --fn <fnName> | CLI 直接查，无需写代码 | | 文档检索 | tcb docs search <关键词> | 终端内直接读官方文档 |

Activation Contract

Read this first when

Starting a new CloudBase project (MP / Web / Hybrid)
Needing structured spec → design → code → test → deploy workflow
Working on test design (case gen, data gen, evaluation, reports)
Managing multiple projects with isolation

Then route to

CloudBase MCP integration → cloudbase skill (CloudBase-specific tools, database, cloud functions, auth)
Claude Code → claude-code-cli-openclaw skill (TDD coding sessions)
Mini Program specific → references/miniprogram-guide.md (TDesign Miniprogram)
Web specific → references/web-guide.md (TDesign React)
Mobile specific → references/mobile-guide.md (TDesign Mobile React)
Backend specific → references/backend-guide.md
Knowledge Base → references/knowledge-base.md (含后台项目必读)

Do NOT use for

Non-CloudBase projects (use platform-specific skills instead)
Simple one-off code generation without lifecycle management

Project Directory Convention

projects/{project-name}/
├── .harness/
│   ├── config.json              # 项目配置（平台类型、envId、appid）
│   ├── state.json               # 当前阶段、进度、阻塞项
│   └── deploy-history.json      # 部署历史
├── specs/{spec-name}/
│   ├── requirements.md          # 需求文档
│   ├── design.md                # 技术方案
│   ├── tasks.md                 # 任务分解
│   └── reviews/                 # 评审记录
├── design/
│   ├── ui/                      # UI 设计（全平台通用）
│   │   ├── design-system.md
│   │   ├── color-palette.md
│   │   └── wireframes/
│   ├── frontend/                 # 前端设计（按平台隔离）
│   │   ├── miniprogram/         # 小程序前端设计（可选）
│   │   │   ├── architecture.md
│   │   │   ├── routing.md
│   │   │   ├── component-tree.md
│   │   │   └── subpackage.md
│   │   └── web/                 # Web 前端设计（可选）
│   │       ├── architecture.md
│   │       ├── routing.md
│   │       └── state-management.md
│   ├── backend/                  # 后台设计（可选，无后台时跳过）
│   │   ├── api-contract.md       # API 契约
│   │   ├── data-model.md         # 数据模型
│   │   ├── cloud-functions.md    # 云函数清单
│   │   └── security-rules.md     # 安全规则
│   └── shared/                   # 跨平台共享设计（可选）
│       └── common-types.md       # 共享类型定义
├── src/                          # 源码
│   ├── miniprogram/              # 小程序源码（可选）
│   │   ├── app.js / app.ts
│   │   ├── app.json
│   │   ├── pages/
│   │   ├── components/
│   │   ├── services/
│   │   └── utils/
│   └── web/                      # Web 源码（TDesign React，可选）
│       ├── index.html
│       ├── src/
│       └── dist/
├── cloud/                        # CloudBase 云函数（共享）
│   ├── {function-name}/
│   └── ...
├── tests/
│   ├── unit/
│   ├── integration/
│   ├── e2e/
│   ├── test-data/
│   └── reports/
└── docs/

平台决定规则：

config.json 中 platform 字段决定哪些目录生效
Hybrid 项目：frontend 下同时存在 miniprogram/、web/ 和 mobile/ 中的任意组合
无后台项目：backend/ 目录不存在，设计阶段跳过

Core Workflow

init → spec → design → coding(TDD) → testing → deploy → iterate
  ↑                                                    │
  └───────────── feedback loop ──────────────────────────┘

Phase Routing

| 用户意图 | 阶段 | 读取 Reference | 执行 | |---------|------|---------------|------| | "新项目" / "初始化" | Init | — | scripts/init_project.py | | "写需求" / "spec" | Spec | references/spec-guide.md | EARS 流程，自动进入下一子步骤直至阶段完成 | | "做设计" / "UI设计" | Design | references/ui-design-guide.md | 确定平台后路由，自动继续 | | "做设计" / "服务设计" | Design | references/service-design-guide.md | 后台设计，自动继续 | | "做设计" / "前端设计" | Design | references/miniprogram-guide.md 或 references/web-guide.md | 按平台路由，自动继续 | | "写代码" / "开发" | Coding | references/coding-guide.md | TDD 红绿重构，自动继续 | | "写测试" / "测试" | Testing | references/testing-guide.md | 用例→数据→执行→报告，自动继续 | | "部署" / "发布" | Deploy | references/deploy-guide.md | 构建→预览→上传→配置，自动继续 | | "CLI" / "tcb" / "命令行" | CLI Ref | 本文档 CLI 章节 | 查询命令/认证方式/SDK 选型 | | "SDK" / "服务端SDK" / "管理端SDK" | SDK Ref | 本文档 SDK 章节 | 选型决策树 + 代码示例 | | "项目状态" | Status | — | scripts/project_status.py | | "继续" | Resume | — | 读 .harness/state.json → 续接 | | "排查" / "诊断" | Diagnose | — | scripts/diagnose.py — tcb CLI + 无头浏览器 | | "日志" / "logs" / "查日志" | LogQuery | — | scripts/query-logs.py — 日志查询/过滤/分析 | | "链路" / "trace" / "查链路" | TraceQuery | — | scripts/diagnose.py trace + trace-collector 云函数 | | "debug" / "根因分析" | Debug | — | scripts/diagnose.py debug <traceId> — trace + logs 综合分析 | | "e2e" / "e2e测试" / "Web测试" | E2E Test | references/automation-guide.md | scripts/run-e2e-web.py — Playwright E2E | | "预览" / "preview" | Preview | — | scripts/preview.py | | "preview --platform web" | Preview Web | — | 构建→上传→返回可访问链接+域名加白提示 | | "preview --platform mp" | Preview MP | — | 构建→preview→输出二维码（手机扫码预览）| | "preview --platform app" | Preview App | — | App不支持预览，打印引导 |

Auto-Continue Mode

重要规则：默认自动进入下一阶段，无须等待用户确认。

当完成当前阶段的一个子步骤后，AI 应自动进入下一子步骤，直到该阶段全部完成才向用户汇报。

阶段内：连续执行，直到所有步骤完成
阶段间：自动进入下一阶段，直到所有阶段完成
用户可随时通过明确指令中断或修改

只在以下情况暂停：

遇到阻塞项（依赖缺失、配置错误、外部依赖不可用）
需要用户做决策（多选项、无明确偏好）
用户明确要求暂停

Design Phase — Platform Routing

Design 阶段根据项目类型路由到不同参考文档：

全部项目必读

references/ui-design-guide.md — UI 设计系统、配色、交互模式

按需读取

| 平台配置 | 读取 | |---------|------| | 含小程序前端 | references/miniprogram-guide.md | | 含 Web 前端 | references/web-guide.md | | 含移动端前端 | references/mobile-guide.md | | 含公众号前端 | references/official-account-guide.md | | 含后台 | references/backend-guide.md + references/service-design-guide.md | | 含知识库需求 | references/knowledge-base.md | | 混合项目 | 全部按需读取，跨平台共享设计存入 design/shared/ |

Hybrid 特殊规则

当项目同时包含多个前端平台时：

设计产物按平台分别存放（frontend/miniprogram/、frontend/web/、frontend/official-account/ 等）
跨平台共享的类型/API 存入 design/shared/
后台统一设计，多端共用
Coding 阶段可并行开发多端，或按优先级顺序开发

Deploy Phase — Detailed Config Output

Deploy 阶段必须产出完整的部署配置，详见 references/deploy-guide.md。核心原则：

小程序 — 通过 miniprogram-ci 构建/预览/上传
Web — 通过 CloudBase 静态托管部署
后台 — 通过 CloudBase MCP 部署云函数/云托管
混合项目 — 统一 deploy-config.json 描述所有组件的部署状态

部署配置模板见 assets/templates/deploy/deploy-config.json.tpl，必须填入：

每个云函数的版本、超时、环境变量
每个云托管服务的镜像版本、实例规格
数据库集合的初始化状态
安全规则的最终配置
订阅消息模板 ID 映射

Phase Gate Summary

| 过渡 | 必要产出 | 校验 | |------|---------|------| | Init → Spec | config.json 含 platform/envId/appid | 文件存在 + valid JSON | | Spec → Design | requirements.md + design.md + tasks.md | validate_spec.py 通过 + 用户确认 | | Design → Coding | 前端/后台设计文档（按平台配置） | 跨平台一致性检查 + 用户确认 | | Coding → Testing | 全部任务完成 + 单元测试通过 | npm test exit 0 | | Testing → Deploy | 测试报告，覆盖率 ≥80%，无 P0/P1 失败 | 报告文件存在 + 指标达标 | | Deploy → 下一Spec | deploy-history.json 更新 + 所有组件部署状态 | 配置与实际环境一致 |

Integration with Other Skills

| Skill | 何时委托 | 方式 | |-------|---------|------| | cloudbase | CloudBase MCP、云函数、数据库、Auth、存储 | 读取 cloudbase skill 路由表 | | claude-code-cli-openclaw | TDD 编码会话、复杂实现 | 启动 Claude Code session | | spec-workflow (cloudbase 子 skill) | EARS 方法论基础 | 读取 references/spec-workflow/ |

规则： 调用 CloudBase MCP 工具前必须先读 cloudbase skill。CloudBase Activation Contract 优先于本 skill。

Resource Index

scripts/

| 脚本 | 用途 | |------|------| | init_project.py | 初始化项目脚手架，按平台类型生成目录 | | preview.py | Web/MP/App 预览，支持云开发部署和手机扫码预览 | | diagnose.py | 环境诊断 + 链路追踪：tcb CLI 查询、trace 查询、debug 根因分析 | | query-logs.py | 高级日志查询：过滤、分析、trace 关联、tail 监控 | | run-e2e-web.py | Web E2E Playwright：init/check/test/codegen/screenshot | | validate_spec.py | 需求文档质量校验 | | gen_test_cases.py | 从需求生成测试用例 | | gen_test_data.py | 生成 Mock 测试数据 | | project_status.py | 查询/展示项目状态 |

references/

| 文档 | 适用 | |------|------| | spec-guide.md | 全部项目 — Spec 阶段 | | ui-design-guide.md | 全部项目 — UI 设计 | | miniprogram-guide.md | 小程序前端设计 | | web-guide.md | Web 前端设计 | | official-account-guide.md | 公众号前端设计（JSSDK、OAuth）| | backend-guide.md | 后台设计（云函数/云托管） | | service-design-guide.md | API 契约、数据模型 | | coding-guide.md | 全部项目 — 编码规范 + TDD | | testing-guide.md | 全部项目 — 测试方法论 | | deploy-guide.md | 全部项目 — 部署流程 + 配置详情 | | tracing-guide.md | 含后台的项目 — 链路追踪（鹰眼兼容 Trace ID、Span 中间件、日志规范、存储分析） | | knowledge-base.md | 含后台的项目 — 知识库管理（CRUD、搜索、权限、分析） | | references/automation-guide.md | 含后台的项目 — 自动化测试（接口 Jest+SuperTest、小程序 Midscene、Web Playwright） |

assets/templates/

| 目录 | 内容 | |------|------| | project/miniprogram/ | 小程序项目模板 | | project/web/ | Web 项目模板 | | project/official-account/ | 公众号项目模板（H5 + JSSDK）| | project/backend/ | 云函数脚手架模板 | | spec/ | Spec 文档模板 | | testing/ | 测试产出模板 | | deploy/ | 部署配置模板 |

TCB Harness

TCB Harness

Platform Types

CloudBase CLI & SDK 完整参考

CloudBase CLI (tcb) — 安装与认证

CloudBase CLI 命令速查（15 个模块）

1. 环境管理 tcb env ...

2. 云函数 tcb fn ...

3. 数据库 tcb db ...

4. 云存储 tcb storage ...

5. 静态网站托管 tcb hosting ...

6. 云应用 tcb app ...

7. 云托管 tcb cloudrun ...

8. HTTP 访问服务 tcb routes / tcb domains / tcb cors ...

9. 权限管理 tcb permission ...

10. 用户与角色 tcb user / tcb role ...

11. 日志检索 tcb logs ...

12. AI 智能体 tcb agent ...

13. 文档检索 tcb docs ...

14. 通用 API tcb api ...

15. 配置文件

CloudBase SDK 体系与选型

服务端 SDK (@cloudbase/node-sdk) — 适用场景

管理端 SDK (@cloudbase/manager-node) — 适用场景

SDK 选型决策树

CLI 与 SDK 的配合策略

Activation Contract

Read this first when

Then route to

Do NOT use for

Project Directory Convention

Core Workflow

Phase Routing

Auto-Continue Mode

Design Phase — Platform Routing

全部项目必读

按需读取

Hybrid 特殊规则

Deploy Phase — Detailed Config Output

Phase Gate Summary

Integration with Other Skills

Resource Index

scripts/

references/

assets/templates/

CloudBase CLI (`tcb`) — 安装与认证

1. 环境管理 `tcb env ...`

2. 云函数 `tcb fn ...`

3. 数据库 `tcb db ...`

4. 云存储 `tcb storage ...`

5. 静态网站托管 `tcb hosting ...`

6. 云应用 `tcb app ...`

7. 云托管 `tcb cloudrun ...`

8. HTTP 访问服务 `tcb routes / tcb domains / tcb cors ...`

9. 权限管理 `tcb permission ...`

10. 用户与角色 `tcb user / tcb role ...`

11. 日志检索 `tcb logs ...`

12. AI 智能体 `tcb agent ...`

13. 文档检索 `tcb docs ...`

14. 通用 API `tcb api ...`

服务端 SDK (`@cloudbase/node-sdk`) — 适用场景

管理端 SDK (`@cloudbase/manager-node`) — 适用场景