快速开始

此快速入门会引导你使用 CloudBase CLI 部署一个 Vue Website

0. 开通云开发服务

如果你已经拥有按量计费的云开发环境，你可以跳过此步骤。

在开始使用云开发服务之前，您需要登录腾讯云 云开发控制台，确保已经开通了云开发服务，并且已经创建了可以使用的环境。如果您不了解如何创建环境，可以参照云开发快速入门 - 开通环境 文档进行操作。

1. 登录

首先登录您的腾讯云账号，在获取到您的授权之后，CloudBase CLI 才能操作您的资源。CloudBase CLI 提供了两种获取授权的方式：腾讯云-云开发控制台授权以及腾讯云-云 API 密钥授权。

腾讯云-云开发控制台授权

在您的终端中输入下面的命令

tcb login

CloudBase CLI 会自动打开云开发控制台获取授权，您需要点击同意授权按钮允许 CloudBase CLI 获取授权。如您没有登录，您需要登录后才能进行此操作。

提示

如果你的账号不是主账户，请参考登录说明中的子账号登录。

腾讯云-云 API 密钥授权

提示

腾讯云 API 密钥可以操作您名下的所有腾讯云资源，请妥善保存和定期更换密钥，当您更换密钥后，请及时删除旧密钥。

首先您需要到腾讯云官网获取 云 API 密钥，然后在终端中输入下面的命令：

tcb login --key

回车后，请按提示输入云 API 密钥的 SecretId 和 SecretKey 即可完成登录。

CI 中的登录

在 CI（持续集成）构建中，您可以使用下面的方式通过 API 密钥直接登录，避免交互式输入：

tcb login --apiKeyId xxx --apiKey xxx

2. 创建项目

初始化

您可以使用下面的命令创建一个项目，创建项目时 CloudBase CLI 根据您输入的项目名创建一个文件夹，并写入相关的配置和模板文件。

提示

使用 tcb new 命令需要 CLI 1.0+ 版本

tcb new app node-starter

云开发项目是和云开发环境资源关联的实体，云开发项目聚合了云函数、数据库、文件存储等服务，您可以在云开发项目中编写函数，存储文件，并通过 CloudBase 快速的操作您的云函数、文件存储、数据库等资源。

云开发项目文件结构：

.
├── .gitignore
├── functions // 云函数目录
│   └── node-app
│       └── index.js
└── cloudbaserc.json // 项目配置文件

编写函数

默认情况下，所有 Node 和 PHP 函数都统一存放在 functions 目录下，并以函数名作为文件夹名称，如 functions/node-app/index.js。对于 Java 函数时，则需要将 jar 文件名修改为函数名称，放在functions目录下即可，例如 functions/cloudbase.jar。 如果您想将函数存放在其他目录，您可以通过配置文件中的functionRoot选项指定您想存放函数的目录，functionRoot选项代表了云函数文件夹相对于项目根目录的路径。

例如，创建一个 Node.js 函数 App，下面是functions/app/index.js的内容

"use strict";

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

修改配置

默认情况下，项目配置存储在 cloudbaserc.json 文件中，默认生成的函数配置为 Node 语言相关的配置，其他语言如 PHP，Java 等需要修改对应的 handler（运行入口）和 runtime（运行时），参考 配置文件 cloudbaserc.json 文件说明部分。

如果您想指定其他文件作为配置文件，可以在使用 CLI 命令时添加--config-file config-path参数指定配置文件，目前支持 JS 和 JSON 格式的配置文件。

{
  "envId": "xxx",
  "functionRoot": "./functions",
  "functions": [
    {
      "name": "node-app",
      "timeout": 5,
      "envVariables": {},
      "runtime": "Nodejs10.15",
      "memorySize": 128,
      "handler": "index.main"
    }
  ]
}

3. 部署函数

在项目根目录下（cloudbaserc.json 所在目录）运行 tcb fn deploy node-app 命令，即可部署 node-app 函数

tcb fn deploy node-app

部署完成后可以使用 tcb fn list 命令查看已经部署完成的函数列表

tcb fn list