veFaaS CLI

veFaaS CLI 是火山引擎 veFaaS 的命令行工具，用于在终端中完成登录、项目初始化、应用部署、函数管理、沙箱管理、网关管理和 OpenAPI 调用。

如果你在 AI Agent 中使用 veFaaS，建议同时安装 veFaaS Skill。CLI 负责真实执行命令，Skill 负责向 Agent 提供 veFaaS 的使用说明、最佳实践、部署工作流和常见排障路径。

安装 CLI

一键安装 CLI 和 veFaaS Skill：

npx @volcengine/vefaas-cli@latest install

全局安装 CLI：

npm i -g @volcengine/vefaas-cli@latest

或使用 pnpm：

pnpm add -g @volcengine/vefaas-cli@latest

验证安装：

vefaas --version
vefaas --help

安装 Skill

veFaaS Skill 面向 AI Agent 场景，说明比 CLI --help 更完整，包含：

• 什么时候使用 veFaaS CLI
• 如何部署 Web 应用和静态站点
• 如何管理函数、沙箱、环境变量和网关
• 常见错误的诊断方式
• Agent 调用 CLI 时应遵循的工作流和安全约定

安装或更新 veFaaS Skill：

vefaas skills update

如果 CLI 尚未安装，也可以直接使用 skills CLI：

npx -y skills add vefaas-dev/skills -g -y

安装后，你可以在支持 Skill 的 Agent 中直接提出 veFaaS 相关需求，例如：

帮我把当前项目部署到 veFaaS
检查这个函数为什么访问失败
把 .env 导入到已关联的函数环境变量

Skill 文档：https://www.volcengine.com/docs/6662/2222391

环境要求

• Node.js >= 18
• npm 或 pnpm
• 普通安装和使用不需要手动安装 Bun

认证

交互式登录：

vefaas login

浏览器 SSO 登录：

vefaas login --sso

非交互环境可以使用 AK/SK：

vefaas login --accessKey <AK> --secretKey <SK>

也可以直接通过环境变量提供凭据：

VOLC_ACCESS_KEY_ID=<AK> VOLC_SECRET_ACCESS_KEY=<SK> vefaas fn list

退出登录：

vefaas logout

查看当前凭据状态：

vefaas whoami

诊断当前环境、项目配置和凭据状态：

vefaas doctor
vefaas doctor -o json

常用命令

查看帮助：

vefaas --help
vefaas <command> --help

初始化或关联项目：

vefaas init
vefaas link

部署当前项目：

vefaas deploy

函数管理：

vefaas fn list
vefaas fn info --id <functionId>
vefaas fn invoke --id <functionId>
vefaas fn logs --id <functionId>

沙箱管理：

vefaas sandbox list
vefaas sandbox create --help
vefaas sandbox instance list --id <sandboxId>

网关管理：

vefaas gateway list
vefaas gateway routes --gateway-id <gatewayId>

直接调用 veFaaS OpenAPI：

vefaas api ListFunctions --PageSize 10 -o table

输出格式

默认输出为文本。可以通过 -o / --output 切换格式：

vefaas fn list -o table
vefaas fn list -o json
vefaas fn list -o yaml

JSON 输出可以配合 --jq 过滤：

vefaas fn list -o json --jq '.data.functions[0].Name'

表格输出可以限制字段和行数：

vefaas fn list -o table --fields Id,Name,Runtime --limit 10

环境变量

| 变量 | 说明 | |-|-| | VOLC_TOKEN | 使用 token 凭据。优先级高于 AK/SK。 | | VOLC_ACCESS_KEY_ID | 火山引擎 Access Key ID。 | | VOLC_SECRET_ACCESS_KEY | 火山引擎 Secret Access Key。 | | VOLC_SESSION_TOKEN | 可选 STS session token，需要和 AK/SK 一起使用。 | | VEFAAS_DISABLE_KEYCHAIN=1 | 禁用系统凭据存储，改用本地加密文件 fallback。 | | VEFAAS_HOME=<dir> | 覆盖 CLI 用户配置根目录，凭据和用户配置位于 $VEFAAS_HOME/.vefaas/。 | | NO_UPDATE_NOTIFIER=1 | 关闭版本更新提示。 | | VEFAAS_NO_UPDATE_NOTIFIER=1 | 同样用于关闭版本更新提示。 | | NO_COLOR=1 | 禁用彩色输出。 |

示例：

NO_UPDATE_NOTIFIER=1 vefaas --help
VEFAAS_DISABLE_KEYCHAIN=1 vefaas login --accessKey <AK> --secretKey <SK>
VEFAAS_HOME="$(mktemp -d)" vefaas doctor -o json

故障排查

查看 CLI、运行时、凭据和项目配置状态：

vefaas doctor

更新日志

版本更新内容请查看 CHANGELOG.md。

主页与许可

• 主页：https://console.volcengine.com/vefaas
• 文档：https://www.volcengine.com/docs/6662
• 许可协议：MIT，详见 LICENSE