Docs / CLI

Install the CLI

Install the bitHuman CLI with one command, then verify with bithuman doctor.

Install

macOS (Apple Silicon) — Homebrew:

brew install bithuman-product/bithuman/bithuman-cli

macOS (Apple Silicon) or Linux — universal installer (detects your platform and drops the right self-contained bithuman binary on your PATH; no Intel-Mac build is published):

curl -fsSL https://raw.githubusercontent.com/bithuman-product/homebrew-bithuman/main/install.sh | sh

It’s the same engine that powers the SDKs.

Notepip install bithuman-cli also works, but only on macOS Apple Silicon (there are no Linux or Intel-Mac wheels). On Linux, use the universal installer above. The separate bithuman PyPI package is the Python library, not the CLI — see Python SDK.

Sign in

bithuman login

This opens your browser to sign in to bitHuman. Approve the request and you’re done — bithuman login mints a per-device key, scoped to your account, and stores it in your OS keychain so every other command just works. No copying secrets, no export. On an SSH or headless box (no browser to open), use bithuman login --device and enter the short code it prints. See Commands → Signing in for logout and auth status.

Tip — Prefer to manage the credential yourself (CI, automation)? Skip login and set BITHUMAN_API_SECRET directly — see Configuration. Both paths are fully supported.

Verify

bithuman doctor

doctor checks your install, platform, sign-in, and that everything’s ready to run. Then head to Commands or jump straight in:

bithuman pull modern-court-jester
bithuman run ~/.cache/bithuman/showcase/modern-court-jester.imx

Tipbithuman run prints a local URL (e.g. http://127.0.0.1:8088/<code>) where your agent is live. See Configuration for cloud vs on-device options and Local mode to run fully offline.