Skip to content

README.EN.MD

Latest commit

 

History

History
71 lines (48 loc) · 2.08 KB

README.EN.MD

File metadata and controls

71 lines (48 loc) · 2.08 KB
Raw

Volcengine Command Line Tools

中文 | 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.

Overview

Volcengine CLI is a command-line tool for calling and managing Volcengine OpenAPI. You can use it to configure credentials, switch profiles, discover services and actions, call APIs, and obtain temporary credentials through SSO or Console Login.

Go 1.12+ is recommended.

Quick Install

Install with npm:

npm install -g @volcengine/cli
ve version

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

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

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: service discovery, API calls, fixed flags, JSON body, arrays, and nested parameters.
  5. Advanced Usage: shell completion, colored output, debug logs, and FAQ.

Security and privacy

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