2026-01-15 06:12:54 +00:00
|
|
|
---
|
2026-01-30 03:15:10 +01:00
|
|
|
summary: "CLI reference for `openclaw onboard` (interactive onboarding wizard)"
|
2026-01-15 06:12:54 +00:00
|
|
|
read_when:
|
|
|
|
|
- You want guided setup for gateway, workspace, auth, channels, and skills
|
2026-01-31 16:04:03 -05:00
|
|
|
title: "onboard"
|
2026-01-15 06:12:54 +00:00
|
|
|
---
|
|
|
|
|
|
2026-01-30 03:15:10 +01:00
|
|
|
# `openclaw onboard`
|
2026-01-15 06:12:54 +00:00
|
|
|
|
|
|
|
|
Interactive onboarding wizard (local or remote Gateway setup).
|
|
|
|
|
|
2026-02-05 13:46:11 -05:00
|
|
|
## Related guides
|
2026-01-31 21:13:13 +09:00
|
|
|
|
2026-02-05 13:46:11 -05:00
|
|
|
- CLI onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
|
|
|
|
|
- CLI onboarding reference: [CLI Onboarding Reference](/start/wizard-cli-reference)
|
|
|
|
|
- CLI automation: [CLI Automation](/start/wizard-cli-automation)
|
|
|
|
|
- macOS onboarding: [Onboarding (macOS App)](/start/onboarding)
|
2026-01-15 06:12:54 +00:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
```bash
|
2026-01-30 03:15:10 +01:00
|
|
|
openclaw onboard
|
|
|
|
|
openclaw onboard --flow quickstart
|
|
|
|
|
openclaw onboard --flow manual
|
|
|
|
|
openclaw onboard --mode remote --remote-url ws://gateway-host:18789
|
2026-01-15 06:12:54 +00:00
|
|
|
```
|
|
|
|
|
|
2026-01-22 23:07:40 +00:00
|
|
|
Flow notes:
|
2026-01-31 21:13:13 +09:00
|
|
|
|
2026-01-22 23:07:40 +00:00
|
|
|
- `quickstart`: minimal prompts, auto-generates a gateway token.
|
|
|
|
|
- `manual`: full prompts for port/bind/auth (alias of `advanced`).
|
2026-01-30 03:15:10 +01:00
|
|
|
- Fastest first chat: `openclaw dashboard` (Control UI, no channel setup).
|
2026-02-05 13:46:11 -05:00
|
|
|
|
|
|
|
|
## Common follow-up commands
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
openclaw configure
|
|
|
|
|
openclaw agents add <name>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<Note>
|
|
|
|
|
`--json` does not imply non-interactive mode. Use `--non-interactive` for scripts.
|
|
|
|
|
</Note>
|
