# 介绍

Tencent CloudBase Toolkit 是腾讯云 - 云开发发布的 VS Code(Visual Studio Code)插件。该插件可以让您更好地在本地进行云开发项目开发和代码调试,并且轻松将项目部署到云端。

通过 Tencent CloudBase Toolkit 插件,您可以:

  • 在本地快速创建云开发项目
  • 从多种模板快速创建云函数
  • 同步云端的云函数列表,并下载函数代码到本地
  • 部署云函数到云端,并进行云端安装依赖
  • 对云函数进行管理,如删除云函数、查看云函数详细信息
  • 增量更新云函数文件
  • 删除云端的云函数文件
  • 部署静态托管文件到云端

同时,VS Code 插件也支持了云函数本地调试与云端调试,帮助你快速定位代码问题

# 快速开始

# 安装

  1. 运行 VS Code IDE
  2. 打开 VS Code 插件市场
  3. 在搜索框中输入 Tencent CloudBase Toolkit,单击搜索框下方列表中的 Tencent CloudBase Toolkit 插件查看详情并选择【install】

# 创建环境

如果您已经开通了云开发服务,并创建了相关环境,可以跳过此步骤。

  1. 登录腾讯云官方账号

    打开腾讯云官网,注册腾讯云账号,然后登录账号。如有账号,可以直接登录。

  2. 开通云开发

    进入云开发主页,授予相关权限开通使用。

  3. 创建环境

    点击 新建环境,输入环境名称,选择按量计费模式,点击立即开通,等待服务开通完成后继续进行下面的操作。

# 配置

# 1. 单击左侧导航栏的图标,打开已安装好的 Tencent CloudBase Toolkit 插件。

# 2. 点击登录

# 3. 选择登录方式

CloudBase Toolkit 提供了两种登录方式,您可以通过腾讯云 - 云开发控制台登录,也可以使用腾讯云访问秘钥登录。

# 4. 创建配置文件

登录成功后,在 VSCode 窗口的右下方会有 “登录成功” 的提示。同时,如果当前项目下没有检测到 cloudbaserc.json 配置文件,CloudBase Toolkit 会提示您创建云开发项目,或创建配置文件。

创建云开发项目会拉取云端模块创建全新的项目,而创建配置文件只会在当前目录下生成 cloudbaserc.json 配置文件。

# 创建项目

注意:CloudBase Toolkit 插件依赖于 cloudbaserc.json 配置文件,只有当前项目的根目录下存在 cloudbaserc.json 配置文件时,才能使用 CloudBase Toolkit 插件进行相关操作。

如果您还没有云开发项目,可以使用初始化操作创建一个全新的云开发项目,CloudBase Toolkit 提供了部分模板项目供选择。

打开一个空的文件夹,点击侧边栏的云开发图标,点击下图示例中的条目

选择使用的云开发环境

选择使用的模板

等待模板下载完成,右下角会有提示。欢迎贡献您的模板~~

项目目录结构

# 注销登录

使用 Ctrl+Shift+P 唤起命令面板,输入 cloudbase 进行搜索,选择注销登录命令即可。