Coding

Volcengine Vefaas

Try it

Deploy and manage serverless applications on Volcengine veFaaS. Use when the user wants to deploy web apps, manage functions (pull code, upload and deploy),...

What it does

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.

The skill document

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:

  1. 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
  2. Check CLI: vefaas --version to verify installation
  3. Check Auth: vefaas login --check to verify login status
    • If not logged in, run vefaas login --sso (opens browser, auto-completes when user authorizes - no manual input needed)
  4. Deploy: vefaas deploy --newApp --gatewayName $(vefaas run listgateways --first) --yes
  5. Access: vefaas domains to view URLs

Quick Commands

PurposeCommand
Check authvefaas login --check
Login (SSO)vefaas login --sso (non-interactive: opens browser, auto-completes when authorized, recommended)
Login (AK/SK)vefaas login --accessKey --secretKey
Init from templatevefaas init --template
Deploy new appvefaas deploy --newApp --gatewayName $(vefaas run listgateways --first) --yes
Deploy existingvefaas deploy --app --yes
List gatewaysvefaas run listgateways --first
View URLsvefaas domains
Set env varvefaas env set KEY VALUE
View configvefaas config list
Pull codevefaas pull --func
Inspect projectvefaas inspect

Global Options

OptionDescription
-d, --debugEnable debug mode for troubleshooting
--yesNon-interactive mode (required for CI/AI coding)
--regionRegion 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 --yes for 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.json after linking
  • Use --debug or -d to troubleshoot issues

Related skills

volcengine-cli

Create and manage Volcengine cloud resources through the ve CLI with safe authentication and confirmation flows.

38 installs2 stars

Volcengine Prepare

Use when the user wants to deploy a local directory or GitHub repository to Volcengine and needs the project analyzed, the app shape understood, and a ranked...

8 installs

volcengine-deploy

Deploy a local project directory or Git repository to Volcengine as a running, reachable cloud service. USE WHEN: deploy to Volcengine, deploy to 火山引擎/火山, deploy this repo/project, publish current code, launch the app, run it in the cloud, expose it as a service, deploy to ECS/VKE/veFaaS, run on ECS, push to VKE, deploy as serverless/FaaS, or the user wants the agent to choose a Volcengine hosting target. If the user only asks which Volcengine deployment target to choose, use `volcengine-prepare` skill first. Not for creating a single standalone resource — use `volcengine-cli` skill for that.

9 installs

volcengine-landing-zone

Use when the user asks to analyze, consult, setup, manage, configure, or design a Volcengine Landing Zone, including organization, accounts, finance, identity, cloudtrail, or network infrastructure.

5 installs

Volcengine Iac

Use Terraform/IaC for Volcengine resources only when the user explicitly chooses Terraform/IaC, already has a Terraform workflow/state, or confirms they need...

9 installs

volcengine-sale

Use when the user asks to purchase, subscribe, provision, open, or place an order for any Volcengine commercial product, or uses Chinese verbs such as "开通 / 购买 / 下单 / 买 / 售卖 / 想买 / 订购" together with a Volcengine product name. Trigger even when the user does not mention "sale" but expresses a clear provisioning intent.