Command-line

The SDK ships a small CLI for two things: checking your license, and opening a one-off browser to a URL without writing a script.

capium status

Print your license entitlements. The first place to look for any licensing issue.

status.sh

python -m capium status

output.json

{
  "plan": "team",
  "sessions_cap": 20,
  "live_sessions": 3,
  "period_end": "2026-09-25T00:00:00Z",
  "heartbeat_every": 60
}

Launch a URL

python -m capium <url> opens a browser to a page and keeps it open until you press Ctrl-C. Everything is configured by environment variables, so it is handy for a quick manual check.

run.sh

# Launch a browser to a URL, configured entirely by env vars.
SEED=200123 PLATFORM=linux GEOIP=1 HUMANIZE=1 \
  python -m capium https://fingerprint.com/demo/

# Persistent profile (keeps cookies/login between runs):
PROFILE=~/profiles/acct1 SEED=200123 \
  python -m capium https://example.com

Environment variables

Variable	Effect
SEED	Identity seed (integer). Omit for a random coherent device.
PLATFORM	windows \| macos \| linux (default windows).
HEADLESS	1 to run headless. Headed is default and recommended.
PROXY	Proxy URL or a named pool (e.g. dataimpulse).
GEOIP	1 to align timezone / geo / WebRTC to the exit.
PROFILE	Directory for a persistent context.
HUMANIZE	1 to enable human-like input.
CAPIUM_LICENSE_KEY	License key (else read from ~/.capium/license).

For anything beyond a quick check, use the SDK directly, see the API reference.

API reference

Errors