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 22+ and npm 10+
- macOS, Windows, or Linux
Install
Section titled “Install”The CLI is published to the GitHub Package Registry. Configure the scope, then install:
npm config set @clustercode:registry https://npm.pkg.github.comnpm 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 |
clustercode doctor | Check system health |
clustercode onboard | Guided setup wizard |
clustercode config | Manage CLI configuration |
clustercode status | Show current state |
Configuration directory
Section titled “Configuration directory”The CLI stores files in ~/.clustercode/:
| File | Purpose |
|---|---|
credentials.json | API key + email from authentication |
worker.json | Worker ID, tenant, and orchestrator URL |
config.json | User preferences (e.g. WORKER_NAME) |
Next steps
Section titled “Next steps”- Register a worker — connect this machine
- CLI reference — full command documentation