volcengine-vefaas

Name: volcengine-vefaas
Author: volcengine

github.com/volcengineCloud & DevOps24100 installsUpdated 4d ago

About volcengine-vefaas

volcengine-vefaas is a CLI skill for deploying and managing serverless applications on Volcengine Function Service. It covers authentication, project initialization, deployment, function code retrieval, and configuration.

Key features

01Initialize projects from templates
02Deploy new or existing applications
03Manage functions and retrieve code
04Configure environment variables
05Check authentication and view domains

Use cases

01Deploy a serverless application from a template
02Publish an existing project through CI/CD
03Pull function code for local work
04Set environment variables and inspect configuration

MCP support

The documentation includes guidance for MCP deployment, including protocol, run.sh, proxy, and path-selection checks. It does not describe MCP tools or resources exposed by the project.

Install

Copy the command and run it in a terminal.

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

After installing, type/volcengine-vefaasin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/

authentication.md

configuration.md

environment-variables.md

framework-detection.md

mcp-deployment.md

troubleshooting.md

references/cookbooks/

deploy-existing-code.md

manage-functions.md

template-quickstart.md

Details

From the project README

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
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
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

Comments

Markdown supported

Details

Author: volcengine
Repository: volcengine/volcengine-skills
Category: Cloud & DevOps
Installs: 100
GitHub stars: 24

Report

More skills

All skills

lark-apps

open.feishu.cn

743.6k

Develop and host Miaoda (Spark/Miaoda) apps: app creation, local full-stack development, cloud generation and iteration, creative design (UI mockups / interactive prototypes / wireframes / landing pages / dashboards / slide decks / visual exploration), integration of AI-related capabilities, Feishu platform capabilities, or other external capabilities; log/Trace/monitoring metric/PV/UV queries; environment variable management; app collaborators and collaboration permissions; app roles and members; and automation triggers (scheduled / record changes / Webhook / Feishu approvals). Use when users want to develop or create a system, tool, platform, or app; develop locally or in the cloud, modify, deploy, publish, launch, or get a shareable link; create a page or website with HTML and deploy it to Miaoda; design, create a mockup, prototype, wireframe, PPT, deck, or visual exploration; or mention Miaoda/Spark/Miaoda apps (links like `/app/app_xxx` or `/page/<token>`, runtime domains like *.aiforce.cloud), app databases, app file storage, open API Keys, visibility, app collaborators/developer permissions, app roles/role members, production logs, API request volume, error volume, latency, traffic, environment variables, or setting up automation tasks, scheduled triggers, or approval-triggered automation for Miaoda apps. Not for regular cloud drive file uploads (lark-drive), Feishu document editing (lark-doc), or native slide creation (lark-slides).

wizard

github.com/mattpocock

580.6k

Generate an interactive bash wizard that walks a human through steps only they can perform. Use when provisioning infrastructure, setting up credentials or CI secrets, walking an unfamiliar third-party dashboard, or running a one-off migration or cutover. Don't invoke this for steps the agent can perform itself.

azure-prepare

github.com/microsoft

574.6k

Prepare azd-based Azure projects for deployment: generates azure.yaml, infrastructure (Bicep/Terraform), and Dockerfiles for the Azure Developer CLI (azd) workflow. USE ONLY when the user explicitly wants to use azd as the deployment tool, or the project already has an azure.yaml file. DO NOT USE FOR: non-azd deployments, Python App Service code-only deploys (use python-appservice-deploy), or cross-cloud migration (use azure-cloud-migrate). WHEN: prepare app for azd, create azure.yaml, set up azd infrastructure, modernize app for Azure with azd, deploy with azd, function app, timer trigger, service bus trigger, event-driven function, managed identity, generate Bicep, generate Terraform, create and deploy to Azure.

azure-ai

github.com/microsoft

573.9k

Use for Azure AI: Search, Speech, OpenAI, Document Intelligence. Helps with search, vector/hybrid search, speech-to-text, text-to-speech, transcription, OCR. WHEN: AI Search, query search, vector search, hybrid search, semantic search, speech-to-text, text-to-speech, transcribe, OCR, convert text to speech.