Setup Wizard
The setup wizard gets a new install ready in a few minutes: it finds your agent CLIs, connects optional gateways and trackers, and imports your projects. Every step can be skipped and revisited later. The wizard is free.
When it opens
On a fresh install, opening ClawIDE sends you to /setup. Once you finish the wizard, / opens the dashboard as usual. You can open the wizard again at any time at /setup, and jump straight to a step with ?step=, for example /setup?step=gateways.
Steps
| Step | What it does |
|---|---|
| Welcome | Explains what’s free and what’s in Pro, and how many trial days are left |
| Agents | Detects installed agent CLIs, shows install commands for the rest and sets your default agent. See Agents and gateways |
| Gateways | Optionally connects model gateways such as OpenRouter or Ollama and assigns them to agents |
| Integrations | Connects Linear, Jira or GitHub Issues. This is a Pro feature: during a trial it’s marked as included, and on Free it offers an upgrade. See Tracker integrations |
| Projects | Sets your projects folder, imports the folders it finds there and chooses your preferred editor |
| Plan | Shows a checklist of what you set up, and lets you start a trial, upgrade or continue on Free |
Use Continue to finish a step, Skip to move on without it, and Back to return. The step rail and progress bar show where you are. Skipped steps are remembered, so you can pick them up later.
Finish setup later
If you skipped something, there are three ways back:
- Settings → Setup lists every step with its status. Use Resume setup to go to the next unfinished step, Open to go to a specific one, or Restart setup to start over.
- Dashboard banner. While any step isn’t done, the dashboard shows “Finish setting up ClawIDE” with the number of steps left. Dismissing the banner hides it until the number of remaining steps changes.
- Command palette. Run Setup wizard.
Reset
Restarting setup, or calling POST /api/onboarding/reset, clears the wizard’s progress as well as the onboarding state, so the wizard opens again on the next visit.
Progress is stored in config.json as setup_steps, with each step marked done or skipped.
API
All endpoints are free.
| Endpoint | Method | Description |
|---|---|---|
/api/setup/state | GET | completed, each step’s status (pending, done or skipped) and the next pending step |
/api/setup/steps/{id} | PUT | Body {"status": "done" | "skipped" | "pending"}. Returns the new state, or 400 for an unknown step or status |
/api/setup/complete | POST | Marks onboarding complete and returns the state |
/api/onboarding/reset | POST | Resets onboarding and setup progress |
/setup | GET | The wizard page. Accepts ?step=<id> |