快速开始

本文介绍如何使用 CloudBase CLI 快速开发和部署云函数。

标准工作空间

云函数项目使用以下标准目录结构：

project/
├── functions/              # 云函数目录（存放所有函数代码）
│   └── <functionName>/     # 具体函数目录
│       ├── index.js        # 函数入口文件
│       └── package.json    # 依赖配置（可选）
└── cloudbaserc.json        # 项目配置文件

• functions/：云函数代码根目录，由 cloudbaserc.json 中的 functionRoot 字段指定
• cloudbaserc.json：项目配置文件，包含环境 ID 和函数配置信息

提示

配置文件的详细说明请参考 配置文件 - 云函数。

快速体验

1. 安装并登录 CLI

npm install -g @cloudbase/cli
tcb login

2. 初始化配置

# 拉取单个云函数配置，如果不存在会自动生成默认配置
tcb config pull fn hello-world

# 也可以同时拉取多个函数配置
tcb config pull fn func1 func2 func3

3. 编写函数代码

在 functions/hello-world/index.js 中创建云函数：

exports.main = async (event, context) => {
  return {
    message: 'Hello World!',
    input: event
  };
};

4. 部署云函数

tcb fn deploy hello-world

部署成功后，可在 云开发控制台 测试函数。

推荐流程

新建云函数

tcb config pull fn <functionName>    # 1. 初始化配置
# 在 functions/<functionName>/ 目录下编写代码
tcb fn deploy <functionName>                # 2. 部署函数

更新云函数

tcb config pull fn <functionName>    # 1. 同步线上配置
tcb fn code download <functionName>         # 2. 下载线上代码（如本地没有代码）
# 修改 functions/<functionName>/ 下的代码
tcb fn code update <functionName>           # 3. 更新代码

批量操作

# 拉取多个函数配置
tcb config pull fn func1 func2 func3

# 拉取配置文件中所有函数
tcb config pull fn --all

# 自动确认模式（跳过交互确认）
tcb config pull fn --all --yes

注意事项

• 操作前先同步配置：每次操作前执行 tcb config pull fn 确保本地配置与线上一致
• 使用配置文件部署：避免交互式操作，确保流程可重复、适合自动化
• 环境变量统一管理：通过配置文件管理环境变量，避免手动修改

下一步

• 云函数配置 - 了解配置文件的详细选项
• 云函数部署 - 了解更多部署方式和参数
• 云函数管理 - 学习函数的日常管理操作