Install CLI
The clustercode CLI is the primary way to bootstrap workers and manage your connection to the orchestrator.
Prerequisites
Section titled “Prerequisites”- Node.js 20.12+ (22 LTS recommended) and npm 10+
- macOS, Windows, or Linux
Install
Section titled “Install”The CLI is published to npm. Install it globally:
npm install -g @clustercode/cliVerify
Section titled “Verify”clustercode --versionWhat it does
Section titled “What it does”The CLI handles:
| Command | Purpose |
|---|---|
clustercode login | Authenticate via browser OAuth or API token |
clustercode worker | Configure tenant and start the worker (alias: clustercode connect) |
clustercode doctor | Check system health |
clustercode onboard | Guided setup wizard |
clustercode config | Manage CLI configuration |
clustercode status | Show current state |
Next steps
Section titled “Next steps”- Register a worker — connect this machine
- CLI reference — full command documentation