Skip to main content

CLI and client library for the Wealthbox CRM API

Project description

Wealthbox CLI — Command-Line Client for the Wealthbox CRM API

PyPI version Downloads Python 3.11+ CI License

wealthbox-cli (wbox) is a command-line tool and Python client library for the Wealthbox CRM API. It gives financial advisors, developers, and RIA firms full CRUD access to contacts, tasks, events, notes, households, and more — directly from the terminal. Automate your CRM workflows, export data, and integrate Wealthbox into scripts and CI pipelines.

Documentation | PyPI | Changelog | Wealthbox CRM | Wealthbox API Docs

Disclaimer: This is an unofficial, community-built tool. It is not affiliated with, endorsed by, or supported by Wealthbox or its parent company. "Wealthbox" is a trademark of its respective owner.


Why Use wealthbox-cli?

  • No coding required — structured CLI flags replace raw JSON and cURL commands
  • Automate CRM workflows — script bulk updates, data exports, and scheduled tasks
  • Multiple output formats — pipe JSON, CSV, or TSV directly to files or other tools
  • Built for financial advisors and developers — covers contacts, households, tasks, events, notes, categories, and custom fields
  • AI-agent ready — pair with Claude Code or other coding agents for natural-language CRM automation
  • Open source — Apache 2.0 licensed, community-driven, and extensible

Quick Start

pip install wealthbox-cli
wbox config set-token        # paste your Wealthbox API token (masked)
wbox me                      # verify connection

See the Getting Started guide for pipx install, environment variable auth, and other options.


Usage Examples

# List contacts as a table
wbox contacts list --format table

# Create a new client contact
wbox contacts add person --first-name Jane --last-name Doe --contact-type Client

# Export tasks to CSV
wbox tasks list --format csv > tasks.csv

# Create a task linked to a contact
wbox tasks add "Follow up call" --due-date "2026-04-10T09:00:00-07:00" --contact 12345

# Add a meeting note
wbox notes add "Discussed retirement plan" --contact 12345

# Schedule an event
wbox events add "Annual Review" --starts-at "2026-05-01T10:00:00-07:00" --ends-at "2026-05-01T11:00:00-07:00"

For the full command list, see the CLI Reference.


Supported Resources

Resource List Get Create Update Delete
Contacts Yes Yes Yes Yes Yes
Households Yes Yes Yes Yes Yes
Tasks Yes Yes Yes Yes Yes
Events Yes Yes Yes Yes Yes
Notes Yes Yes Yes Yes
Users Yes
Activity Yes
Categories Yes

Use with AI Coding Agents

wealthbox-cli ships with a Claude Code skill that lets AI agents manage your CRM through natural language. Instead of memorizing CLI flags, just describe what you want:

/wealthbox-crm create a contact for Jane Doe, she's a new prospect
/wealthbox-crm list my tasks due this week
/wealthbox-crm add a note to contact 123 about today's meeting
/wealthbox-crm find all contacts tagged "VIP" and export to CSV

The skill translates your intent into the correct wbox commands, handles flag construction, and validates inputs — making it ideal for advisors who want CRM automation without learning CLI syntax.

Install the skill

Download the skill directly from GitHub into your Claude Code skills directory:

macOS/Linux:

git clone --depth 1 https://github.com/massive-value/wealthbox-cli.git /tmp/wealthbox-cli \
  && cp -r /tmp/wealthbox-cli/docs/skills/wealthbox-crm ~/.claude/skills/wealthbox-crm \
  && rm -rf /tmp/wealthbox-cli

Windows (PowerShell):

git clone --depth 1 https://github.com/massive-value/wealthbox-cli.git $env:TEMP\wealthbox-cli
Copy-Item -Recurse $env:TEMP\wealthbox-cli\docs\skills\wealthbox-crm $env:USERPROFILE\.claude\skills\wealthbox-crm
Remove-Item -Recurse -Force $env:TEMP\wealthbox-cli

Windows (Command Prompt):

git clone --depth 1 https://github.com/massive-value/wealthbox-cli.git %TEMP%\wealthbox-cli
xcopy /E /I %TEMP%\wealthbox-cli\docs\skills\wealthbox-crm %USERPROFILE%\.claude\skills\wealthbox-crm
rmdir /S /Q %TEMP%\wealthbox-cli

If you already have the repo cloned, just copy from your local checkout:

macOS/Linux:

cp -r docs/skills/wealthbox-crm ~/.claude/skills/wealthbox-crm

Windows (PowerShell):

Copy-Item -Recurse docs\skills\wealthbox-crm $env:USERPROFILE\.claude\skills\wealthbox-crm

Windows (Command Prompt):

xcopy /E /I docs\skills\wealthbox-crm %USERPROFILE%\.claude\skills\wealthbox-crm

Firm-specific configuration

Customize the skill for your firm's defaults, required fields, and naming conventions:

macOS/Linux:

cp ~/.claude/skills/wealthbox-crm/firm-config.example.md ~/.claude/skills/wealthbox-crm/firm-config.md

Windows (PowerShell):

Copy-Item $env:USERPROFILE\.claude\skills\wealthbox-crm\firm-config.example.md $env:USERPROFILE\.claude\skills\wealthbox-crm\firm-config.md

Windows (Command Prompt):

copy %USERPROFILE%\.claude\skills\wealthbox-crm\firm-config.example.md %USERPROFILE%\.claude\skills\wealthbox-crm\firm-config.md

Edit firm-config.md with your firm's conventions. The agent will then apply them automatically — for example, always tagging new contacts with your firm name, setting default contact types, or running multi-step onboarding workflows.

Works with other agents too

The wbox CLI is a standard command-line tool. Any AI coding agent that can execute shell commands — Claude Code, GitHub Copilot CLI, Cursor, or custom agent frameworks — can use it to read and write Wealthbox data. The included skill just makes Claude Code aware of the full command surface.


Architecture

src/wealthbox_tools/
    cli/        # Typer commands — user-facing, delegates to client
    client/     # Async HTTP client built from mixins
    models/     # Pydantic v2 models for input validation

Built with Typer, httpx, and Pydantic v2. See Contributing for the full architecture guide and how to add new resources.


Contributing

git clone https://github.com/massive-value/wealthbox-cli
cd wealthbox-cli
python -m venv .venv

Activate the virtual environment:

Platform Command
macOS/Linux source .venv/bin/activate
Windows (PowerShell) .venv\Scripts\Activate.ps1
Windows (Command Prompt) .venv\Scripts\activate.bat

Then install and test:

pip install -e ".[dev]"
pytest

See CONTRIBUTING.md for the full guide.


Troubleshooting

401 Unauthorized — Check your API token. Run wbox config show to verify.

Date format errors — Use ISO 8601: "2026-04-01T10:00:00-07:00" or "2026-04-01T10:00:00Z". Date-only fields use "YYYY-MM-DD".

Writes appear to succeed but nothing changed — Some category-constrained writes silently no-op. Check valid values first with wbox contacts categories contact-types.


Disclaimer

This is an unofficial, community-built tool. It is not affiliated with, endorsed by, or supported by Wealthbox or its parent company. "Wealthbox" is a trademark of its respective owner. Use of this tool is subject to the Wealthbox API Terms of Service.


License

Apache 2.0 — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wealthbox_cli-1.0.4.tar.gz (51.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wealthbox_cli-1.0.4-py3-none-any.whl (58.1 kB view details)

Uploaded Python 3

File details

Details for the file wealthbox_cli-1.0.4.tar.gz.

File metadata

  • Download URL: wealthbox_cli-1.0.4.tar.gz
  • Upload date:
  • Size: 51.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wealthbox_cli-1.0.4.tar.gz
Algorithm Hash digest
SHA256 57b2a12e74dfb87e7a6fc642f1a5971bffafc5c2dd62af6114b407b772280d59
MD5 32bc9e287d6a742a4b3068f08b5c72df
BLAKE2b-256 e5f0a1d338bd030b1cf0e35dc37fcbc89246eec7e5366cddab9878eca5110977

See more details on using hashes here.

Provenance

The following attestation bundles were made for wealthbox_cli-1.0.4.tar.gz:

Publisher: ci.yml on massive-value/wealthbox-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wealthbox_cli-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: wealthbox_cli-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 58.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wealthbox_cli-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 739e04975caf2123a9cd3fc654395f0a58e67fb8c9a012a1784ec7fe0af12954
MD5 f2608d23db9dae2e298e7362cd6c560a
BLAKE2b-256 bb7eb0d77f8c70e8afc6af7a2cfe79dd4c11aa53db20b4043404c7fe27f0bf71

See more details on using hashes here.

Provenance

The following attestation bundles were made for wealthbox_cli-1.0.4-py3-none-any.whl:

Publisher: ci.yml on massive-value/wealthbox-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page