Get the FREE Ultimate OpenClaw Setup Guide →

voluum-setup-install

Scanned
npx machina-cli add skill markab21/voluum-cli/voluum-setup-install --openclaw
Files (1)
SKILL.md
1.8 KB

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.

Supported environments

  • Linux
  • macOS
  • Windows through WSL (Ubuntu/Debian recommended)

Prerequisites

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

Install from source

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

Optional global CLI link:

bun link
voluum --help

Without linking:

node dist/index.js --help

Configure authentication

Login using Voluum access credentials:

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

Or use environment variables:

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

Token storage path:

  • ~/.voluum-cli/config.json

First-run verification

voluum --help
voluum reports --help
voluum offers --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.

Source

git clone https://github.com/markab21/voluum-cli/blob/main/plugins/voluum-cli-assistant/skills/voluum-setup-install/SKILL.mdView on GitHub

Overview

voluum-setup-install provides a guided path to clone, build, and configure voluum-cli on Linux and macOS, with Windows support via WSL. It emphasizes prerequisites like git and Bun, authentication options, and basic verification to ensure API access to Voluum. Note: voluum-cli is community-supported, not an official Voluum product, and uses Voluum APIs.

How This Skill Works

The setup uses Bun to install and build the voluum-cli from source, optionally links the CLI for global access, and supports authentication via login or environment variables. Token data is stored at ~/.voluum-cli/config.json, and you can verify functionality with basic help and query commands. If not linked, commands may require node dist/index.js as a fallback.

When to Use It

  • You need to install and configure voluum-cli on Linux or macOS, or Windows via WSL (Ubuntu/Debian recommended).
  • You want to install from source and build the CLI locally rather than using a prebuilt binary.
  • You prefer authenticating with Voluum using accessKeyId/accessKey or environment variables.
  • You want to verify the CLI integrates correctly by running help commands and a sample reports query.
  • You are troubleshooting common setup issues like missing Bun, missing CLI linkage, or missing auth tokens.

Quick Start

  1. Step 1: git clone https://github.com/markab21/voluum-cli.git; cd voluum-cli; bun install; bun run build
  2. Step 2: Optional: bun link to expose the voluum CLI globally; then run voluum --help (or use node dist/index.js --help if not linked)
  3. Step 3: Configure authentication via voluum auth login --accessKeyId '<ACCESS_KEY_ID>' --accessKey '<ACCESS_KEY>' or export VOLUUM_BASE_URL and VOLUUM_TOKEN; verify with voluum --help or voluum reports --help

Best Practices

  • Verify prerequisites (git, Bun, and network access to https://api.voluum.com) before starting.
  • Use bun install and bun run build to compile, and consider bun link for a global voluum command.
  • Authenticate with voluum auth login or set VOLUUM_BASE_URL and VOLUUM_TOKEN for programmatic access.
  • Rely on the token storage at ~/.voluum-cli/config.json to reuse sessions securely.
  • Test with simple commands (voluum --help, voluum reports --help) and a small query to confirm setup.

Example Use Cases

  • git clone https://github.com/markab21/voluum-cli.git; cd voluum-cli; bun install; bun run build; bun link; voluum --help
  • voluum auth login --accessKeyId '<ACCESS_KEY_ID>' --accessKey '<ACCESS_KEY>'
  • export VOLUUM_BASE_URL="https://api.voluum.com"; export VOLUUM_TOKEN="<SESSION_TOKEN>"; 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
  • WSL tip: run install/auth commands inside the WSL shell; if bun is missing, install Bun; if voluum is missing after install, run bun link or use node dist/index.js

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers ↗