clustercode onboard
clustercode onboardDescription
Section titled “Description”An interactive wizard that walks you through the complete setup:
- Runs all health checks (same as
clustercode doctor) - 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
- Re-runs all checks to verify fixes
What onboard doesn’t cover
Section titled “What onboard doesn’t cover”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:
- Agent sign-in — lets the agent think
- Service access tokens (GitHub / Azure DevOps / GitLab) — let the agent reach your code. Set under Settings → Environment Variables → Service access
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.
When to Use
Section titled “When to Use”- First-time setup on a new machine
- After
clustercode doctorreports failures - When you want a one-command setup instead of running individual commands
Difference from doctor
Section titled “Difference from doctor”doctor | onboard | |
|---|---|---|
| Checks health | ✓ | ✓ |
| Fixes issues | Prompts to run onboard | Fixes directly |
| Interactive | Yes (prompts on failure) | Yes |
| Idempotent | Yes | Yes |
Both are safe to run multiple times. onboard is the fix; doctor is the diagnosis.