c0befdee0b
* feat(onboard): add custom/local API configuration flow * ci: retry macos check * fix: expand custom API onboarding (#11106) (thanks @MackDing) * fix: refine custom endpoint detection (#11106) (thanks @MackDing) * fix: streamline custom endpoint onboarding (#11106) (thanks @MackDing) * fix: skip model picker for custom endpoint (#11106) (thanks @MackDing) * fix: avoid allowlist picker for custom endpoint (#11106) (thanks @MackDing) * Onboard: reuse shared fetch timeout helper (#11106) (thanks @MackDing) * Onboard: clarify default base URL name (#11106) (thanks @MackDing) --------- Co-authored-by: OpenClaw Contributor <contributor@openclaw.ai> Co-authored-by: Gustavo Madeira Santana <gumadeiras@gmail.com>
47 lines
1.3 KiB
Markdown
47 lines
1.3 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
|
|
```
|
|
|
|
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 API Endpoint: 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>
|