mirror of
https://github.com/openclaw/openclaw.git
synced 2026-02-19 18:39:20 -05:00
Merged via /review-pr -> /prepare-pr -> /merge-pr.
Prepared head SHA: 5b98d6514e
Co-authored-by: ENCHIGO <38551565+ENCHIGO@users.noreply.github.com>
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com>
Reviewed-by: @gumadeiras
1.7 KiB
1.7 KiB
summary, read_when, title
| summary | read_when | title | |
|---|---|---|---|
| CLI reference for `openclaw onboard` (interactive onboarding wizard) |
|
onboard |
openclaw onboard
Interactive onboarding wizard (local or remote Gateway setup).
Related guides
- CLI onboarding hub: Onboarding Wizard (CLI)
- Onboarding overview: Onboarding Overview
- CLI onboarding reference: CLI Onboarding Reference
- CLI automation: CLI Automation
- macOS onboarding: Onboarding (macOS App)
Examples
openclaw onboard
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --mode remote --remote-url ws://gateway-host:18789
Non-interactive custom provider:
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 ofadvanced).- 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
openclaw configure
openclaw agents add <name>