ByteNoteByteNote

字节笔记本

2026年5月3日

EdgeOne CLI - 腾讯云 Pages 部署工具

API中转
¥120

腾讯云 EdgeOne Pages CLI 工具使用指南,涵盖安装登录、项目初始化、本地开发、部署和 CI/CD 集成。

概述

EdgeOne CLI 是腾讯云 EdgeOne Pages 平台的命令行工具,可以在项目中生成、配置和调试函数,也可以将构建产物以文件夹或 Zip 包的形式上传至 Pages 平台。

安装

bash
npm install -g edgeone

验证安装:

bash
edgeone -v    # 查看版本
edgeone -h    # 查看所有命令

登录

执行登录命令,选择站点类型:

bash
edgeone login
  • 选择 Global(国际站)或 China(中国站)
  • 建议选择 Global 以确保获取准确的数据和信息
  • 在弹出的浏览器窗口完成登录

查看当前登录账号:

bash
edgeone whoami

切换账号:

bash
edgeone switch

项目初始化

bash
edgeone pages init

初始化过程中,项目根目录下会生成:

  • edge-functions/node-functions/ 文件夹
  • 示例函数文件

本地开发

bash
edgeone pages dev

注意事项

  1. 该命令会优先读取 edgeone.json 中的 devCommand 参数
  2. 若没有该配置则读取 package.jsondev 命令
  3. 切记请勿在 edgeone.jsonpackage.json 中配置 edgeone pages dev
  4. Edge Functions 调试服务有启动次数限制,尽量避免频繁退出启动
  5. Dev 服务内热更新不会增加启动次数

参数

对于不方便执行 edgeone login 的环境,可添加参数:

bash
edgeone pages dev -t, --token <API_TOKEN>

访问地址

默认在本地 8088 端口启动服务:

  • 前端页面:http://localhost:8088/
  • Pages 函数:访问路径为 edge-functionsnode-functions 文件夹下函数文件的路径

函数调用示例

javascript
// ./node-functions/api/my-functions.js
fetch('/api/my-functions', {
    method: 'POST',
    body: JSON.stringify({ data: 'example' }),
})

关联项目

如果需要使用 KV 存储能力或将控制台已设置的环境变量同步到本地调试:

bash
edgeone pages link

按要求输入项目名称(准备工作中已创建的 Pages 项目名)

注意

  • 对于不方便执行 edgeone login 的环境,可添加 -t, --token 参数
  • 若需要 link 的项目不存在,也可以在 CLI 的指引下直接创建新项目

部署

Git 提交部署

本地开发调试完成后,将项目代码推送到 Git 远端,即可触发 Pages 后台的 CI 构建部署。

本地部署

bash
edgeone pages deploy [<directoryOrZip>] [-n <name>] [-e <env>]

参数说明

参数说明
<directoryOrZip>需要部署的文件夹或 ZIP 包路径
-n, --name需要部署的项目名称,项目不存在则自动创建新项目
-e, --env部署目标环境,可选值: production 或 preview(默认 production)

[!warning] 注意 执行 deploy 时,CLI 会自动构建并部署至 Pages,无需指定文件夹;若手动构建,则需将 Pages Functions 相关文件夹及 package.json 放入输出目录(如 dist),再执行 edgeone pages deploy ./dist

部署示例

bash
# 生产环境部署
edgeone pages deploy

# 预览环境部署
edgeone pages deploy -e preview

# 部署指定目录
edgeone pages deploy ./dist

# 部署到指定项目
edgeone pages deploy -n my-project

CI/CD 流水线集成

deploy 命令支持不依赖 Git 的方式,直接从 CI/CD 流水线将文件夹或 ZIP 包部署至 EdgeOne Pages。

bash
edgeone pages deploy [<directoryOrZip>] -n <projectName> -t <token> [-e <env>]

参数说明

参数说明必需性
<directoryOrZip>需要部署的文件夹或 ZIP 包路径可选
-n, --name需要部署的项目名称必填
-t, --token用于 CI/CD 流水线的 API Token必填
-e, --env部署目标环境(production/preview)可选,默认 production

CI 流水线示例

bash
# 生产环境部署
edgeone pages deploy -n project-name -t $EDGEONE_API_TOKEN

# 预览环境部署
edgeone pages deploy -n project-name -e preview -t $EDGEONE_API_TOKEN

API Token 获取方式

在 EdgeOne Pages 控制台生成 API Token,详见官方文档。

环境变量管理

列出所有环境变量

bash
edgeone pages env ls

拉取环境变量到本地

bash
# 拉取到默认文件
edgeone pages env pull

# 拉取到指定文件
edgeone pages env pull -f .env.prod

新增环境变量

bash
edgeone pages env add ENV_VAR_KEY env_var_value

删除环境变量

bash
edgeone pages env rm ENV_VAR_KEY

准备工作

  1. 使用 Gmail 邮箱快速注册登录 腾讯云控制台
  2. 在控制台开通 Pages 服务
  3. 创建新的 Pages 项目,并将其克隆到本地

官方资源

分享: