GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - volcengine/volcengine-cli

BranchesTags
Open more actions menu

Latest commit

 

History

555 Commits
555 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
asset
asset
 
 
cmd
cmd
 
 
docs
docs
 
 
examples/run_script
examples/run_script
 
 
internal
internal
 
 
npm
npm
 
 
scripts
scripts
 
 
skills-setup
skills-setup
 
 
structset
structset
 
 
typeset
typeset
 
 
upgrade
upgrade
 
 
util
util
 
 
.gitignore
.gitignore
 
 
.goreleaser.yml
.goreleaser.yml
 
 
LICENSE.txt
LICENSE.txt
 
 
NOTICE.txt
NOTICE.txt
 
 
README.EN.md
README.EN.md
 
 
README.md
README.md
 
 
SECURITY.md
SECURITY.md
 
 
build.sh
build.sh
 
 
build_asset.sh
build_asset.sh
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
img_new.png
img_new.png
 
 
run.go
run.go
 
 

Repository files navigation

Volcengine Command Line Tools


Volcengine SKILL & CLI Survey

为提高您对火山引擎 SKILL&CLI 的使用体验,邀您参加有奖调研


中文 | English

特别说明

从 v1.0.20 开始,火山引擎 CLI 命令前缀由 volcengine-cli 更新为 ve。低版本不受影响;升级到 v1.0.20 及以后版本后,请同步更新脚本中的命令前缀。

从 v1.1.3 开始,ve 才支持安装和管理 Skill(ve skills 系列命令,以及 npm 安装时自动安装核心 Skill)。v1.1.3 之前的版本没有该能力,请先升级到 v1.1.3 及以上版本再使用。

概述

火山引擎 CLI(ve)是火山引擎的统一命令行入口,面向开发者、自动化脚本和 AI Agent。它提供通用 OpenAPI 调用、凭证与 profile 管理、SSO 和 Console Login,并通过 Proxy-CLI 接入各产品的原生命令,负责按需安装和托管升级;也提供 Skill 管理和 MCP 服务,便于 Agent 使用火山引擎能力。

从源码编译需要 Go 1.18 或更高版本;使用 Release 预编译包或 npm 安装时不需要 Go。

快速安装

使用 npm 安装:

npm install -g @volcengine/cli
ve version

npm 包要求 Node.js >= 14,安装后提供 ve 命令入口。

从 v1.1.3 开始,通过 npm 安装或升级 CLI 时,会自动安装火山引擎的核心 Skill;v1.1.3 之前的版本不会安装 Skill。 Skill 安装失败不影响 CLI 本身安装。若需要暂时跳过 Skill 安装,可设置 VOLCENGINE_CLI_SKIP_SKILLS=1。

也可以从 Release 下载:

  1. 打开 https://github.com/volcengine/volcengine-cli/releases 获取最新版本。
  2. 下载对应操作系统和架构的压缩包。
  3. 解压得到 ve,Windows 下为 ve.exe。

或从源码编译:

sh build.sh

将 ve 放到 PATH 中:

sudo cp ve /usr/local/bin
ve version

升级到最新版本

ve upgrade
  • standalone / Release:下载并原地替换当前二进制
  • npm:委托执行 npm install -g @volcengine/cli@latest(失败时会提示同一条手动命令)
  • Homebrew:依次执行 brew update 与 brew upgrade volcengine-cli

Skill 管理

Skill 安装与管理能力从 v1.1.3 开始提供。请先执行 ve version 确认版本;低于 v1.1.3 时,先通过 ve upgrade 或 npm install -g @volcengine/cli@latest 升级。

核心 Skill 安装到 ~/.agents/skills 和 ~/.claude/skills;检测到 OpenClaw、Hermes Agent 或 Trae 时, 也会安装到对应的 Skill 目录。Codex、Cursor 和 OpenCode 可直接读取 ~/.agents/skills。完整 Skill 清单和使用介绍请参阅 volcengine-skills。

ve skills install
ve skills update
ve skills uninstall
  • install:安装尚未安装的核心 Skill。
  • update:更新到最新版本;本地缺失或修改过的核心 Skill 会恢复为最新官方内容。尚未安装时会直接完成安装。
  • uninstall:卸载由 ve 安装的核心 Skill,但保留本地修改过的内容。

Proxy-CLI

Proxy-CLI 将火山引擎产品 CLI 接入 ve,为用户和 Agent 提供统一的产品能力入口,同时保留各产品自身的命令语义。

产品工具按需加载,仅在实际调用且本地缺少可用程序时下载安装。仅使用 VE 原生 OpenAPI 与配置功能时,不会触发产品 CLI 的下载、安装或启动,这些功能的使用方式保持不变。

使用时,在产品原生命令前加 ve,例如 ve arkcli --help、ve tosutil help;其余子命令和参数保持原样。完整步骤、产品示例与官方文档见 Proxy-CLI 使用指南。

快速开始

ve configure set --profile default --region cn-beijing --access-key AK --secret-key SK
ve sts GetCallerIdentity

也可以使用环境变量:

export VOLCENGINE_ACCESS_KEY=AK
export VOLCENGINE_SECRET_KEY=SK
export VOLCENGINE_REGION=cn-beijing
ve sts GetCallerIdentity

文档

  1. 入门:安装、源码编译、PATH 配置、第一次调用 API。
  2. 认证与登录:AK/SK、默认凭证链、OIDC、ECS 实例角色、SSO、Console Login。
  3. 配置管理:profile 查看、列表、切换、修改、删除。
  4. 使用指南:原生 API 调用、系统参数、JSON body、数组和嵌套参数,以及 --query 过滤和 --output 输出格式。
  5. 高级用法:自动补全、彩色输出、debug 日志、--force 强制泛化调用、常见问题。安全策略配置见配置管理。
  6. MCP 服务:API 发现(list_services、list_apis、get_api_parameters,以及基于官方目录的 search_api)、单次 API 调用、多 API Python 脚本编排(run_script,需显式开启),以及 stdio、SSE、Streamable HTTP、OAuth、Header 凭证与 Region。
  7. Proxy-CLI:产品调用、按需加载、安装升级与官方文档。

Security and privacy

This project takes security seriously. For vulnerability reporting and supported versions, see SECURITY.md.

About

No description, website, or topics provided.

Resources

Readme
Apache-2.0 license

Security policy

Security policy
Activity
Custom properties

Stars

74 stars

Watchers

2 watching

Forks

9 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.