Getting Started

Install the Vruum CLI, log in with a personal access token, run vruum init to wire your harness, and make your first call.

Vruum exposes your full revenue platform — pipeline, people, deals, outreach, marketing, and knowledge base — to agents through two interchangeable surfaces that hit the same authorized backend endpoints under your own token: the vruum CLI and the MCP server. This page takes you from zero to your first call.

1. Install the CLI

The CLI needs Node ≥ 22. Install it globally, run it once with npx, or grab a standalone binary:

# npm (requires Node ≥ 22)
npm install -g @vruum/cli
# or run without installing
npx @vruum/cli --help

# Homebrew (macOS / Linux)
brew tap vruum-gtm/vruum && brew install vruum

# standalone binary (no Node)
curl -fsSL https://vruum.ai/install.sh | sh

2. Log in

vruum authenticates with a personal access token (PAT, vk_live_…). Generate one in the Vruum web app under Settings → API tokens, then store it:

vruum login            # prompts for the token (hidden), stores it in ~/.vruum
vruum whoami           # confirm who you are authenticated as

For CI and agent harnesses, skip the stored credential entirely and pass the token via the VRUUM_TOKEN environment variable. See Auth for the full token model, environment variables, and operator --for-company scoping.

3. Wire your harness — `vruum init`

vruum init is the one-shot setup command. It detects every supported AI coding harness in the current project and, for each, registers the Vruum MCP, links the client-safe skills, and writes instruction files:

vruum init             # wire MCP + skills + instructions into detected harnesses

Restart your harness afterwards to load the Vruum MCP. See vruum init for the full list of harnesses and what each integration wires.

4. Your first command

Every CLI command supports --json for stable, scriptable output. Confirm your auth and list your deals:

vruum whoami --json
vruum deal list --json | jq '.[] | {name, stage, amount}'

The process exit code is the agent's success signal (0 success, 3 auth failure, 2 other 4xx, 1 server/network error).

Where to next