Skip to content

clustercode onboard

Terminal window
clustercode onboard

An interactive wizard that walks you through the complete setup:

  1. Runs all health checks (same as clustercode doctor)
  2. For each failure, offers to fix it:
    • Not logged in → runs the login flow
    • Worker not configured → runs tenant selection
    • WSL2 missing (Windows) → installs WSL2 and Ubuntu distro
    • container runtime missing → installs and starts Podman
    • Orchestrator unreachable → shows configuration guidance
  3. Re-runs all checks to verify fixes

onboard prepares the machine. It does not sign your agents in, and it does not store your service access tokens — both are done in the dashboard, per worker:

A worker that passes doctor can still fail its first run without these. A missing source-provider token is the most common cause of a failed first run on a new setup.

  • First-time setup on a new machine
  • After clustercode doctor reports failures
  • When you want a one-command setup instead of running individual commands
doctoronboard
Checks health
Fixes issuesPrompts to run onboardFixes directly
InteractiveYes (prompts on failure)Yes
IdempotentYesYes

Both are safe to run multiple times. onboard is the fix; doctor is the diagnosis.