/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
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install volcengine-vefaas - After installation, invoke the skill by name or use
/volcengine-vefaas - Provide required inputs per the skill's parameter spec and get structured output
What is 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),... It is an AI Agent Skill for Claude Code / OpenClaw, with 38 downloads so far.
How do I install Volcengine Vefaas?
Run "/install volcengine-vefaas" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Volcengine Vefaas free?
Yes, Volcengine Vefaas is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Volcengine Vefaas support?
Volcengine Vefaas is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Volcengine Vefaas?
It is built and maintained by sdk-team (@volc-sdk-team); the current version is v1.0.0.