← Back to Skills Marketplace
volc-sdk-team

Volcengine Vefaas

by sdk-team · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ⚠ suspicious
38
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install volcengine-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),...
README (SKILL.md)

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 \x3Cname> --gatewayName $(vefaas run listgateways --first) --yes
  5. 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 \x3CAK> --secretKey \x3CSK>
Init from template vefaas init --template \x3Cname>
Deploy new app vefaas deploy --newApp \x3Cname> --gatewayName $(vefaas run listgateways --first) --yes
Deploy existing vefaas deploy --app \x3Cname> --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 \x3Cname>
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:

References

Detailed documentation on specific topics:

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
Usage Guidance
Install only if you understand it can install a global CLI, use Volcengine credentials, upload project code/artifacts, create or change cloud resources, expose services, and read or modify runtime environment variables. Prefer SSO or managed CI secrets, avoid pasting long-lived AK/SK values into chat or shell history, verify the target app/region/gateway before any --yes command, review .vefaasignore and env files before deploy, and redact debug logs before sharing.
Capability Tags
requires-oauth-tokenrequires-sensitive-credentials
Capability Assessment
Purpose & Capability
The capability matches the stated purpose: installing and using the vefaas CLI to deploy applications, manage functions, configure environment variables, pull code, and inspect Volcengine veFaaS projects.
Instruction Scope
The instructions repeatedly recommend deployment and mutation commands with --yes, including creating new apps, deploying to existing apps/functions, pushing code, and changing configuration, without consistently requiring the user to confirm target app, region, gateway, environment, cost, exposure, or rollback path.
Install Mechanism
Installation uses a global npm install from an unpinned remote latest.tgz URL. That is coherent for a CLI skill, but it gives broad local install authority and lacks version pinning or integrity guidance.
Credentials
The skill necessarily handles cloud credentials, uploaded source/build artifacts, remote environment variables, logs, and public service URLs. That is purpose-aligned, but the documentation under-explains trust boundaries, secret exposure risks, and what may be uploaded or printed.
Persistence & Privilege
Credentials are documented as saved under ~/.vefaas/auth.json, project links under .vefaas/config.json, and debug logs under ~/.vefaas/logs. These persistence points are disclosed, but the skill does not provide sufficient guidance on permissions, redaction, or cleanup.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install volcengine-vefaas
  3. After installation, invoke the skill by name or use /volcengine-vefaas
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of volcengine-vefaas: a CLI for managing serverless applications on Volcengine veFaaS. - Deploy and manage serverless applications and functions via command line. - Supports authentication with SSO or AK/SK, project initialization, deployment, and configuration. - Includes commands for managing environment variables, viewing domains, and pulling function code. - Offers global options for debugging, non-interactive usage, and region selection. - Provides documentation links and cookbooks for common deployment scenarios.
Metadata
Slug volcengine-vefaas
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is 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),... It is an AI Agent Skill for Claude Code / OpenClaw, with 38 downloads so far.

How do I install Volcengine Vefaas?

Run "/install volcengine-vefaas" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Volcengine Vefaas free?

Yes, Volcengine Vefaas is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Volcengine Vefaas support?

Volcengine Vefaas is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Volcengine Vefaas?

It is built and maintained by sdk-team (@volc-sdk-team); the current version is v1.0.0.

💬 Comments