跳到主要内容

快速开始

使用 CloudBase CLI 开发和部署云函数。

标准工作空间​

云函数项目使用以下目录结构:

project/
├── functions/ # 云函数目录
│ └── <functionName>/ # 函数目录
│ ├── index.js # 函数入口文件
│ └── package.json # 依赖配置(可选)
└── cloudbaserc.json # 项目配置文件
  • functions/:云函数代码根目录,由 cloudbaserc.json 中的 functionRoot 指定。
  • cloudbaserc.json:项目配置文件,包含环境 ID 和函数配置。

配置字段说明见 函数配置。

部署第一个函数​

安装并登录​

# 国际站账号改用 tcb login --intl true
npm install -g @cloudbase/cli
tcb login

初始化配置​

# 拉取单个函数配置,不存在时自动生成默认配置
tcb config pull fn hello-world

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

编写函数代码​

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

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

部署​

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,确保本地配置与线上一致。
  • 使用配置文件部署,避免交互式操作,流程可重复并适合自动化。
  • 环境变量通过配置文件统一管理,不要手动修改。

下一步​