跳到主要内容

快速开始

本教程将引导您使用 CloudBase CLI 完成从环境配置到云函数部署的完整流程

前置准备​

开通云开发服务​

登录腾讯云 云开发控制台，确保已经开通云开发服务并创建了可用环境。如果不了解如何创建环境，请参考 创建云开发环境 文档。

步骤一：登录认证​

登录腾讯云账号以授权 CloudBase CLI 操作您的资源。

国际站用户注意

登录前需要先执行命令 tcb config set isIntl true 切换到国际站链路，或设置环境变量 TCB_IS_INTL=true。

在终端中输入：

tcb login

CloudBase CLI 会自动打开云开发控制台获取授权，点击同意授权按钮即可完成登录。

提示
设备码登录

在 Agent、远程服务器、容器等无法直接打开浏览器的环境中，tcb login 会自动使用设备码授权流程：

  1. 执行 tcb login 后，CLI 会输出一个授权链接和用户码
  2. 在任意可访问浏览器的设备上打开授权链接，输入用户码并完成确认
  3. CLI 自动轮询完成登录

详细说明请参考 设备码登录。

步骤二：创建云开发项目​

初始化项目​

使用 tcb new 命令创建项目，支持 Node.js、PHP、Java 等多种语言。

⚠️ 注意：使用 tcb new 命令需要 CLI 1.0+ 版本

使用以下命令创建项目，创建一个名为 app 的 Node.js 云函数项目：

tcb new app node-starter

项目文件结构：

project/
├── cloudbaserc.json          # 项目配置文件（v2.1 声明式配置）
├── functions                 # 云函数目录
│   ├── node-app              # Event 函数
│   │   └── index.js
│   └── api-server            # HTTP 函数（可选）
│       └── scf_bootstrap
├── web                       # 前端静态托管目录（可选）
│   └── dist/
└── cloudbase/migrations/     # 数据库迁移文件（可选）
    └── 20260101120000_init.sql

编写云函数​

目录规范：

  • Node/Python：存放在 functions 目录下，以函数名作为文件夹名称
    • 示例：functions/node-app/index.js
    • 示例：functions/node-app/index.py
  • Java 函数：将 jar 文件重命名为函数名，放在 functions 目录下
    • 示例：functions/cloudbase.jar

自定义函数目录：

通过配置文件中的 functionRoot 选项指定函数存放目录（相对于项目根目录的路径）。

示例代码：

创建一个 Node.js 函数 functions/app/index.js：

"use strict";

exports.main = async (event, context) => {
  console.log("Hello World");
  console.log("Event:", event);
  console.log("Context:", context);

  return {
    code: 0,
    message: "success",
  };
};

项目配置文件​

项目配置文件为根目录 cloudbaserc.json 文件。默认生成的是 Node.js 函数配置，其他语言（PHP、Java 等）需要修改对应的 handler（运行入口）和 runtime（运行时）。

快捷生成配置：运行以下命令可智能检测项目中的云函数、静态托管目录和前端框架（Vite/Next.js/Nuxt 等），交互式一键生成完整 cloudbaserc.json。已登录时还会自动填充默认环境 ID。详细配置说明请参考 配置文件文档。

tcb config init

→ 初始化配置详细说明

配置示例：

{
  "envId": "your-env-id",
  "functionRoot": "./functions",
  "functions": [
    {
      "name": "node-app",
      "timeout": 5,
      "envVariables": {},
      "runtime": "Nodejs16.13",
      "memorySize": 128,
      "handler": "index.main"
    }
  ]
}

步骤三：部署云函数​

部署指定函数​

在项目根目录（cloudbaserc.json 所在目录）运行以下命令部署 node-app 函数：

tcb fn deploy node-app

查看函数列表​

部署完成后，使用以下命令查看已部署的函数列表：

tcb fn list

声明式整体部署（推荐）​

如果使用 v2.1 声明式配置（cloudbaserc.json 含 version: "2.1"），可一键编排部署全部资源（云函数 + 静态托管 + 网关 + 数据库迁移）：

tcb deploy

→ 声明式部署详细说明

推荐先执行 tcb validate 校验配置，再 tcb deploy --dry-run 预览变更计划，确认无误后实际部署。