029b77c85b
Merged via /review-pr -> /prepare-pr -> /merge-pr. Prepared head SHA: 5b98d6514e73f7ee934a350f3b38619c70f49aed Co-authored-by: ENCHIGO <38551565+ENCHIGO@users.noreply.github.com> Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com> Reviewed-by: @gumadeiras
60 lines
1.7 KiB
Markdown
60 lines
1.7 KiB
Markdown
---
|
|
summary: "CLI reference for `openclaw onboard` (interactive onboarding wizard)"
|
|
read_when:
|
|
- You want guided setup for gateway, workspace, auth, channels, and skills
|
|
title: "onboard"
|
|
---
|
|
|
|
# `openclaw onboard`
|
|
|
|
Interactive onboarding wizard (local or remote Gateway setup).
|
|
|
|
## Related guides
|
|
|
|
- CLI onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
|
|
- Onboarding overview: [Onboarding Overview](/start/onboarding-overview)
|
|
- 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)
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
openclaw onboard
|
|
openclaw onboard --flow quickstart
|
|
openclaw onboard --flow manual
|
|
openclaw onboard --mode remote --remote-url ws://gateway-host:18789
|
|
```
|
|
|
|
Non-interactive custom provider:
|
|
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--auth-choice custom-api-key \
|
|
--custom-base-url "https://llm.example.com/v1" \
|
|
--custom-model-id "foo-large" \
|
|
--custom-api-key "$CUSTOM_API_KEY" \
|
|
--custom-compatibility openai
|
|
```
|
|
|
|
`--custom-api-key` is optional in non-interactive mode. If omitted, onboarding checks `CUSTOM_API_KEY`.
|
|
|
|
Flow notes:
|
|
|
|
- `quickstart`: minimal prompts, auto-generates a gateway token.
|
|
- `manual`: full prompts for port/bind/auth (alias of `advanced`).
|
|
- Fastest first chat: `openclaw dashboard` (Control UI, no channel setup).
|
|
- Custom Provider: connect any OpenAI or Anthropic compatible endpoint,
|
|
including hosted providers not listed. Use Unknown to auto-detect.
|
|
|
|
## 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>
|