mcpField
V
volcengine-vefaas

volcengine-vefaas

github.com/volcengine云与 DevOps24100 次安装4 天前更新
代码仓库

关于 volcengine-vefaas

volcengine-vefaas 是用于在 Volcengine Function Service 上部署和管理无服务器应用的命令行技能，涵盖登录、项目初始化、部署、函数代码获取和配置。

主要功能

  1. 01从模板初始化项目
  2. 02部署新建或已有应用
  3. 03管理函数并获取代码
  4. 04配置环境变量
  5. 05检查登录状态并查看域名

适用场景

  1. 01从模板部署无服务器应用
  2. 02通过 CI/CD 发布现有项目
  3. 03拉取函数代码以便本地处理
  4. 04设置环境变量并检查配置

MCP 相关

文档提供 MCP 部署指南，涉及协议、run.sh、代理和路径选择检查；未说明该项目向 MCP 客户端暴露的工具或资源。

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/volcengine-vefaas确认已加载。

包含的文件

除 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

详细介绍

volcengine-vefaas：Volcengine FaaS CLI

vefaas 是 Volcengine Function Service（veFaaS）的命令行工具。它通过简化的工作流，实现无服务器应用部署、函数管理和配置。

安装

npm i -g https://vefaas-cli.tos-cn-beijing.volces.com/volcengine-vefaas-latest.tgz

验证安装：

vefaas --version

核心工作流

典型的部署流程：

  1. 检查 Node.js：node --version（需要 >= 18，推荐 20+）
    • 如果版本过低，可使用 nvm（nvm use 20）或 fnm（fnm use 20）切换版本，或手动安装较新版本
  2. 检查 CLI：运行 vefaas --version 验证安装
  3. 检查认证：运行 vefaas login --check 验证登录状态
    • 如果尚未登录，运行 vefaas login --sso（打开浏览器，用户授权后会自动完成，无需手动输入）
  4. 部署：vefaas deploy --newApp <name> --gatewayName $(vefaas run listgateways --first) --yes
  5. 访问：运行 vefaas domains 查看 URL

常用命令

用途命令
检查认证vefaas login --check
登录（SSO）vefaas login --sso（非交互式：打开浏览器，授权后自动完成，推荐）
登录（AK/SK）vefaas login --accessKey <AK> --secretKey <SK>
从模板初始化vefaas init --template <name>
部署新应用vefaas deploy --newApp <name> --gatewayName $(vefaas run listgateways --first) --yes
部署已有应用vefaas deploy --app <name> --yes
列出网关vefaas run listgateways --first
查看 URLvefaas domains
设置环境变量vefaas env set KEY VALUE
查看配置vefaas config list
拉取代码vefaas pull --func <name>
检查项目vefaas inspect

全局选项

选项说明
-d, --debug启用调试模式以排查问题
--yes非交互模式（CI/AI 编码时必需）
--region覆盖区域（例如 cn-beijing）

操作指南

常见场景的分步指南：

参考文档

特定主题的详细文档：

重要说明

  • 在 CI/CD 和 AI 编码场景中，非交互模式务必使用 --yes
  • 使用 $(vefaas run listgateways --first) 获取可用网关
  • 关联项目后，配置会存储在 .vefaas/config.json 中
  • 使用 --debug 或 -d 排查问题

评论

支持 Markdown