voluum-setup-install

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

voluum-cli

is community-supported software released under the MIT License. It is not an official Voluum product and is not endorsed or supported by Voluum. It uses publicly documented Voluum APIs.

voluum-cli

是由社区支持的软件，基于MIT许可证发布。它并非Voluum的官方产品，也未得到Voluum的认可或支持，仅使用公开文档化的Voluum APIs。

Supported environments

支持的环境

Linux
macOS
Windows through WSL (Ubuntu/Debian recommended)

Linux
macOS
Windows（通过WSL，推荐使用Ubuntu/Debian）

Prerequisites

前置要求

```
git
```
Bun runtime (
```
bun --version
```
)
Network access to
```
https://api.voluum.com
```

```
git
```
Bun运行时（可通过
```
bun --version
```
验证）
能够访问
```
https://api.voluum.com
```
的网络环境

Install from source

从源码安装

bash

git clone https://github.com/markab21/voluum-cli.git
cd voluum-cli
bun install
bun run build

Optional global CLI link:

bash

bun link
voluum --help

Without linking:

bash

node dist/index.js --help

bash

git clone https://github.com/markab21/voluum-cli.git
cd voluum-cli
bun install
bun run build

可选：全局CLI链接：

bash

bun link
voluum --help

不使用链接的方式：

bash

node dist/index.js --help

Configure authentication

配置认证

bash

voluum auth login --accessKeyId '<ACCESS_KEY_ID>' --accessKey '<ACCESS_KEY>'

Or use environment variables:

bash

export VOLUUM_BASE_URL="https://api.voluum.com"
export VOLUUM_TOKEN="<SESSION_TOKEN>"

Token storage path:

```
~/.voluum-cli/config.json
```

使用Voluum访问凭证登录：

bash

voluum auth login --accessKeyId '<ACCESS_KEY_ID>' --accessKey '<ACCESS_KEY>'

或使用环境变量：

bash

export VOLUUM_BASE_URL="https://api.voluum.com"
export VOLUUM_TOKEN="<SESSION_TOKEN>"

令牌存储路径：

```
~/.voluum-cli/config.json
```

First-run verification

首次运行验证

bash

voluum --help
voluum reports --help
voluum reports query --path /report --query from=2026-02-17T00:00:00Z,to=2026-02-18T00:00:00Z,groupBy=campaign,limit=5 --pretty

bash

voluum --help
voluum reports --help
voluum reports query --path /report --query from=2026-02-17T00:00:00Z,to=2026-02-18T00:00:00Z,groupBy=campaign,limit=5 --pretty

Troubleshooting

故障排除

```
bun: command not found
```
: install Bun and restart shell.

voluum: command not found

: rerun

bun link

or use

node dist/index.js

No auth token found

: run

voluum auth login

or set

VOLUUM_TOKEN

WSL users: run install/auth commands inside WSL shell, not PowerShell CMD.

```
bun: command not found
```
：安装Bun并重启终端。

voluum: command not found

：重新运行

bun link

或使用

node dist/index.js

。

No auth token found

：运行

voluum auth login

或设置

VOLUUM_TOKEN

环境变量。

WSL用户：请在WSL终端内执行安装/认证命令，不要在PowerShell或CMD中操作。