vefaas

📁 vefaas-dev/skills 📅 Jan 29, 2026

总安装量

周安装量

#30493

全站排名

安装命令

npx skills add https://github.com/vefaas-dev/skills --skill vefaas

Agent 安装分布

trae 6

opencode 5

gemini-cli 2

github-copilot 2

codex 2

kimi-cli 2

Skill 文档

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
Check CLI: vefaas --version to verify installation
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)
Deploy: vefaas deploy --newApp <name> --gatewayName $(vefaas run listgateways --first) --yes
Access: vefaas domains to 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
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

GitHub 仓库 ↗ ← 返回陌讯 Skills 聚合平台