Skip to content

README.EN.MD

Latest commit

 

History

History
124 lines (84 loc) · 5.55 KB

README.EN.MD

File metadata and controls

124 lines (84 loc) · 5.55 KB
Raw

Volcengine Command Line Tools

Volcengine SKILL & CLI Survey

To help us improve your experience with Volcengine SKILL & CLI, we invite you to participate in our survey . Rewards are available for participants.

中文 | English

Special Note

Starting from v1.0.20, the Volcengine CLI command prefix changed from volcengine-cli to ve. Earlier versions are not affected. After upgrading to v1.0.20 or later, update scripts that still call volcengine-cli.

Starting from v1.1.3, ve can install and manage Skills (the ve skills commands, and the automatic core Skill installation performed by the npm package). Versions earlier than v1.1.3 do not support Skills, so upgrade to v1.1.3 or later first.

Overview

Volcengine CLI (ve) is a unified command-line entry point for developers, automation scripts, and AI agents using Volcengine. It provides general OpenAPI calls, credential and profile management, SSO, and Console Login. It also exposes native product commands through Proxy-CLI, with on-demand installation and managed upgrades, and provides Skill management and an MCP server for agents.

Go 1.18 or later is required to build from source. Prebuilt Release and npm installations do not require Go.

Quick Install

Install with npm:

npm install -g @volcengine/cli
ve version

The npm package requires Node.js >= 14 and provides the ve command.

Starting from v1.1.3, installing or upgrading the CLI with npm also installs the core Volcengine Skills; versions earlier than v1.1.3 install no Skills. A Skill installation failure does not fail the CLI installation. Set VOLCENGINE_CLI_SKIP_SKILLS=1 to skip Skill installation temporarily.

You can also download from Release:

  1. Open https://github.com/volcengine/volcengine-cli/releases.
  2. Download the archive for your OS and architecture.
  3. Extract it to get ve, or ve.exe on Windows.

Or build from source:

sh build.sh

Put ve on PATH:

sudo cp ve /usr/local/bin
ve version

Upgrade to the latest version

ve upgrade
  • standalone / Release: download and replace the current binary in place
  • npm: runs npm install -g @volcengine/cli@latest (on failure, prints the same manual command)
  • Homebrew: runs brew update, then brew upgrade volcengine-cli

Skill Management

Skill installation and management require v1.1.3 or later. Run ve version to check, and upgrade with ve upgrade or npm install -g @volcengine/cli@latest if you are on an older version.

Core Skills are installed under ~/.agents/skills and ~/.claude/skills. When OpenClaw, Hermes Agent, or Trae is detected, Skills are also installed in its dedicated directory. Codex, Cursor, and OpenCode can read ~/.agents/skills directly. See volcengine-skills for the full Skill catalog and usage details.

ve skills install
ve skills update
ve skills uninstall
  • install: Install core Skills that are not already installed.
  • update: Update to the latest version and restore missing or modified core Skills to the latest official content. If no Skills are installed, it performs an installation.
  • uninstall: Remove core Skills installed by ve while preserving locally modified content.

Proxy-CLI

Proxy-CLI brings Volcengine product CLIs into ve, giving users and agents a unified entry point while preserving each product's command semantics.

Product tools load on demand and are downloaded only when invoked without a usable local installation. Using native VE OpenAPI and configuration features does not download, install, or start product CLIs, and those workflows remain unchanged.

Prefix the native product command with ve, for example ve arkcli --help or ve tosutil help, and keep the remaining arguments unchanged. See the Proxy-CLI usage guide for steps, product examples, and official documentation.

Quick Start

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

You can also use environment variables:

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

Documentation

  1. Getting Started: install, build from source, configure PATH, and make the first API call.
  2. Authentication: AK/SK, default credential chain, OIDC, ECS instance role, SSO, and Console Login.
  3. Configuration: inspect, list, switch, update, and delete profiles.
  4. Usage: native API calls, system flags, JSON body, arrays and nested parameters, plus --query filtering and --output formats.
  5. Advanced Usage: shell completion, colored output, debug logs, --force invocation, and FAQ. Safety-policy configuration is documented in Configuration.
  6. MCP Server: stdio, SSE, Streamable HTTP, OAuth, header credentials, and region resolution.
  7. Proxy-CLI: product invocation, on-demand loading, installation, upgrades, and official documentation.

Security and privacy

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