Byted Vefaas Skills

该 Skill 封装 Volcengine veFaaS 命令行工具，提供从模板初始化、部署新应用或已有项目、查看访问域名、管理环境变量、拉取函数代码到故障排查的分步流程，并附带认证、配置、框架检测等参考文档。

volcengine-skills

热度 34.12

最近更新 2026-05-11 17:38:11

分类：开发依赖：代码执行 / 读写文件 / 第三方 API应用场景：DevOps / 自动化脚本

安装技能

复制下面的话术发给你的 Agent，它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill： npx secure-skills-cli add byted-vefaas-skills

Metadata

name: vefaas
description: 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, or work with veFaaS services.
allowed-tools: Bash(vefaas:*)

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