Skip to content

CLI Overview

The clustercode CLI manages workers, authentication, and configuration from your terminal.

The CLI is published to npm. Install it globally:

Terminal window
npm install -g @clustercode/cli

Requires Node.js 22+. Verify the install with clustercode --version.

CommandDescription
clustercode loginAuthenticate via browser OAuth or API token
clustercode workerSelect a tenant and start the worker
clustercode doctorCheck system health
clustercode onboardGuided setup wizard
clustercode configManage CLI configuration
clustercode statusShow current state

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.