CLI Overview
The clustercode CLI manages workers, authentication, and configuration from your terminal.
Install
Section titled “Install”The CLI is published to npm. Install it globally:
npm install -g @clustercode/cliRequires Node.js 20.12 or newer. Verify the install with clustercode --version.
Commands
Section titled “Commands”| Command | Description |
|---|---|
clustercode login | Authenticate via browser OAuth or API token |
clustercode worker | Select a tenant and start the worker (alias: clustercode connect; add --doctor to run health checks first) |
clustercode doctor | Check system health |
clustercode onboard | Guided setup wizard |
clustercode config | Manage CLI configuration |
clustercode status | Show current state |
clustercode machine | Maintain the container runtime’s machine — compact returns unused disk space to Windows |
New here? Run clustercode onboard — it checks everything and walks you through login, tenant selection, and container runtime setup in one step.
Run clustercode status at any time to see your current login, worker, and connection state.