/install volcengine-vefaas
volcengine-vefaas: Volcengine FaaS CLI
vefaas is the command-line tool for Volcengine Function Service (veFaaS). It enables serverless application deployment, function management, and configuration through a streamlined workflow.
Installation
npm i -g https://vefaas-cli.tos-cn-beijing.volces.com/volcengine-vefaas-latest.tgz
Verify installation:
vefaas --version
Core Workflow
The typical deployment pattern:
- Check Node.js:
node --version(requires >= 18, recommended 20+)- If version is too low, switch using nvm (
nvm use 20) or fnm (fnm use 20), or manually install a newer version
- If version is too low, switch using nvm (
- Check CLI:
vefaas --versionto verify installation - Check Auth:
vefaas login --checkto verify login status- If not logged in, run
vefaas login --sso(opens browser, auto-completes when user authorizes - no manual input needed)
- If not logged in, run
- Deploy:
vefaas deploy --newApp \x3Cname> --gatewayName $(vefaas run listgateways --first) --yes - Access:
vefaas domainsto view URLs
Quick Commands
| Purpose | Command |
|---|---|
| Check auth | vefaas login --check |
| Login (SSO) | vefaas login --sso (non-interactive: opens browser, auto-completes when authorized, recommended) |
| Login (AK/SK) | vefaas login --accessKey \x3CAK> --secretKey \x3CSK> |
| Init from template | vefaas init --template \x3Cname> |
| Deploy new app | vefaas deploy --newApp \x3Cname> --gatewayName $(vefaas run listgateways --first) --yes |
| Deploy existing | vefaas deploy --app \x3Cname> --yes |
| List gateways | vefaas run listgateways --first |
| View URLs | vefaas domains |
| Set env var | vefaas env set KEY VALUE |
| View config | vefaas config list |
| Pull code | vefaas pull --func \x3Cname> |
| Inspect project | vefaas inspect |
Global Options
| Option | Description |
|---|---|
-d, --debug |
Enable debug mode for troubleshooting |
--yes |
Non-interactive mode (required for CI/AI coding) |
--region |
Region override (e.g., cn-beijing) |
Cookbooks
Step-by-step guides for common scenarios:
- Template Quickstart - Create and deploy from official templates
- Deploy Existing Code - Deploy your existing project
- Manage Functions - Manage functions (pull code, upload and deploy)
References
Detailed documentation on specific topics:
- Authentication - Login methods and credentials
- Configuration - Config files and settings
- Environment Variables - Managing env vars
- Framework Detection - Supported frameworks and auto-detection
- Troubleshooting - Debug mode, common issues, and solutions
Important Notes
- Always use
--yesfor non-interactive mode in CI/CD and AI coding scenarios - Use
$(vefaas run listgateways --first)to get an available gateway - Config is stored in
.vefaas/config.jsonafter linking - Use
--debugor-dto troubleshoot issues
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install volcengine-vefaas - 安装完成后,直接呼叫该 Skill 的名称或使用
/volcengine-vefaas触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
Volcengine Vefaas 是什么?
Deploy and manage serverless applications on Volcengine veFaaS. Use when the user wants to deploy web apps, manage functions (pull code, upload and deploy),... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 38 次。
如何安装 Volcengine Vefaas?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install volcengine-vefaas」即可一键安装,无需额外配置。
Volcengine Vefaas 是免费的吗?
是的,Volcengine Vefaas 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
Volcengine Vefaas 支持哪些平台?
Volcengine Vefaas 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 Volcengine Vefaas?
由 sdk-team(@volc-sdk-team)开发并维护,当前版本 v1.0.0。