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), configure environment variables, inspect veFaaS projects, troubleshoot vefaas CLI/auth/framework issues, or work with veFaaS services.
How do I install this agent skill?
npx skills add https://github.com/volcengine/volcengine-skills --skill volcengine-vefaasIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides comprehensive instructions for using the Volcengine veFaaS CLI to manage and deploy serverless applications. All mentioned external resources, including the CLI installation package and API endpoints, reside on official Volcengine infrastructure. The skill follows industry standard practices for authentication and environment variable management within a cloud deployment context.
- Socketwarn
1 alert: gptSecurity
- Snykfail
Risk: HIGH · 1 issue
What does this agent skill do?
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 <name> --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 <AK> --secretKey <SK> |
| Init from template | vefaas init --template <name> |
| Deploy new app | vefaas deploy --newApp <name> --gatewayName $(vefaas run listgateways --first) --yes |
| Deploy existing | vefaas deploy --app <name> --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 <name> |
| 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
- MCP Deployment - MCP protocol,
run.sh, proxy, and path-selection checks - 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
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/volcengine/volcengine-skills/volcengine-vefaas">View volcengine-vefaas on skillZs</a>