2026-01-15 06:12:54 +00:00
|
|
|
---
|
2026-03-15 22:00:13 -07:00
|
|
|
summary: "CLI reference for `openclaw setup` (initialize config/workspace or run the setup wizard)"
|
2026-01-15 06:12:54 +00:00
|
|
|
read_when:
|
2026-03-15 22:00:13 -07:00
|
|
|
- You want first-run setup without the guided wizard
|
|
|
|
|
- You want the guided setup wizard via `openclaw setup --wizard`
|
2026-01-15 06:12:54 +00:00
|
|
|
- You want to set the default workspace path
|
2026-01-31 16:04:03 -05:00
|
|
|
title: "setup"
|
2026-01-15 06:12:54 +00:00
|
|
|
---
|
|
|
|
|
|
2026-01-30 03:15:10 +01:00
|
|
|
# `openclaw setup`
|
2026-01-15 06:12:54 +00:00
|
|
|
|
2026-03-15 22:00:13 -07:00
|
|
|
Initialize `~/.openclaw/openclaw.json` and the agent workspace, or run the guided setup wizard.
|
2026-01-15 06:12:54 +00:00
|
|
|
|
|
|
|
|
Related:
|
2026-01-31 21:13:13 +09:00
|
|
|
|
2026-01-15 06:12:54 +00:00
|
|
|
- Getting started: [Getting started](/start/getting-started)
|
2026-03-15 22:00:13 -07:00
|
|
|
- Setup wizard: [Setup Wizard (CLI)](/start/wizard)
|
|
|
|
|
- macOS app onboarding: [Onboarding](/start/onboarding)
|
2026-01-15 06:12:54 +00:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
```bash
|
2026-01-30 03:15:10 +01:00
|
|
|
openclaw setup
|
|
|
|
|
openclaw setup --workspace ~/.openclaw/workspace
|
2026-03-15 22:00:13 -07:00
|
|
|
openclaw setup --wizard
|
|
|
|
|
openclaw setup --wizard --install-daemon
|
2026-01-15 06:12:54 +00:00
|
|
|
```
|
|
|
|
|
|
2026-03-15 22:00:13 -07:00
|
|
|
Without flags, `openclaw setup` only ensures config + workspace defaults.
|
|
|
|
|
Use `--wizard` for the full guided flow.
|
2026-01-15 06:12:54 +00:00
|
|
|
|
2026-03-15 22:00:13 -07:00
|
|
|
## Modes
|
|
|
|
|
|
|
|
|
|
- `openclaw setup`: initialize config/workspace defaults only
|
|
|
|
|
- `openclaw setup --wizard`: guided setup for auth, gateway, channels, and skills
|
|
|
|
|
- `openclaw setup --wizard --non-interactive`: scripted setup flow
|
|
|
|
|
|
|
|
|
|
## Related guides
|
|
|
|
|
|
|
|
|
|
- Setup wizard guide: [Setup Wizard (CLI)](/start/wizard)
|
|
|
|
|
- Setup wizard reference: [CLI Setup Reference](/start/wizard-cli-reference)
|
|
|
|
|
- Setup wizard automation: [CLI Automation](/start/wizard-cli-automation)
|
|
|
|
|
- Legacy alias: [`openclaw onboard`](/cli/onboard)
|
