Skip to content

Getting Started with Wealthbox CLI

This guide walks you through installing wealthbox-cli and configuring it to connect to your Wealthbox CRM account.

Installation

One-line installer (no Python required)

If you don't have Python installed, the bootstrap script handles everything: it downloads a prebuilt wbox, places it on your PATH, prompts for your API token, and offers to install the AI agent skill.

Installs uv (which provisions Python automatically) and uses it to put wbox on your PATH.

curl -LsSf https://raw.githubusercontent.com/massive-value/wealthbox-cli/main/scripts/install.sh | bash

Downloads a standalone PyInstaller-bundled wbox.exe (no Python, no uv) to %LOCALAPPDATA%\Programs\wbox\. Pass -SkipSkills (via iwr -OutFile install.ps1; .\install.ps1 -SkipSkills) to skip the AI agent skill.

irm https://raw.githubusercontent.com/massive-value/wealthbox-cli/main/scripts/install.ps1 | iex

Either install supports wbox self upgrade for future updates. If you instead install via pip / pipx / uv tool (below), use the corresponding package-manager upgrade command — wbox self upgrade will refuse with the right pointer.

pip install wealthbox-cli

On systems where the system Python is externally managed (Ubuntu 23.04+, Debian 12+), pip install outside a virtual environment is blocked by PEP 668. Use pipx to install CLI tools in isolated environments:

pipx install wealthbox-cli

This puts wbox and wb on your PATH without touching system Python.

From Source (development)

git clone https://github.com/massive-value/wealthbox-cli
cd wealthbox-cli
python -m venv .venv
source .venv/bin/activate  # macOS/Linux
# OR
.venv\Scripts\activate     # Windows
pip install -e ".[dev]"

Getting Your Wealthbox API Token

  1. Log in to Wealthbox
  2. Click the three dots menu (...) in the top right
  3. Go to Settings → API Access
  4. Click Create Access Token

Storing Your Token

wbox config set-token

This prompts for your Wealthbox API token (input is masked) and stores it in ~/.config/wbox/config.json (Linux/macOS) or %APPDATA%\wbox\config.json (Windows).

Other configuration commands:

wbox config show     # display stored config (token masked)
wbox config clear    # remove stored config

Alternative Authentication Methods

For CI, scripting, or containers:

export WEALTHBOX_TOKEN="your_api_token_here"

wbox contacts list --token your_api_token_here

Token is resolved in this order: --token flag → WEALTHBOX_TOKEN env var → config file.

Verify Your Setup

# Check your identity
wbox me

# List users in your workspace
wbox users list

# List your first contact
wbox contacts list --per-page 1

Next Steps