Skip to content

CLI Overview

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

The CLI is published to the GitHub Package Registry. Configure the scope, then install:

Terminal window
npm config set @clustercode:registry https://npm.pkg.github.com
npm install -g @clustercode/cli
CommandDescription
clustercode loginAuthenticate via browser OAuth or API token
clustercode workerConfigure tenant and start the worker
clustercode doctorCheck system health
clustercode onboardGuided setup wizard
clustercode configManage CLI configuration
clustercode statusShow current state
  • All commands read configuration from ~/.clustercode/config.json
  • Credentials are stored in ~/.clustercode/credentials.json
  • Worker identity is stored in ~/.clustercode/worker.json
~/.clustercode/
├── credentials.json # API key + email from login
├── worker.json # Worker ID, tenant, orchestrator URL
└── config.json # User preferences (e.g. WORKER_NAME)
Getting Started Concepts Guides CLI Self-Hosting Reference Links