alvis
bedb527145
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
76 lines
2.9 KiB
Markdown
76 lines
2.9 KiB
Markdown
---
|
|
summary: "Overview of OpenClaw onboarding options and flows"
|
|
read_when:
|
|
- Choosing an onboarding path
|
|
- Setting up a new environment
|
|
title: "Onboarding overview"
|
|
sidebarTitle: "Onboarding Overview"
|
|
---
|
|
|
|
OpenClaw has two onboarding paths. Both configure auth, the Gateway, and
|
|
optional chat channels — they just differ in how you interact with the setup.
|
|
|
|
## Which path should I use?
|
|
|
|
| | CLI onboarding | macOS app onboarding |
|
|
| -------------- | -------------------------------------- | --------------------------- |
|
|
| **Platforms** | macOS, Linux, Windows (native or WSL2) | macOS only |
|
|
| **Interface** | Terminal wizard | Guided UI + Crestodian chat |
|
|
| **Best for** | Servers, headless, full control | Desktop Mac, visual setup |
|
|
| **Automation** | `--non-interactive` for scripts | Manual only |
|
|
| **Command** | `openclaw onboard` | Launch the app |
|
|
|
|
Most users should start with **CLI onboarding** — it works everywhere and gives
|
|
you the most control.
|
|
|
|
## What onboarding configures
|
|
|
|
Regardless of which path you choose, onboarding sets up:
|
|
|
|
1. **Model provider and auth** — API key, OAuth, or setup token for your chosen provider
|
|
2. **Workspace** — directory for agent files, bootstrap templates, and memory
|
|
3. **Gateway** — port, bind address, auth mode
|
|
4. **Channels** (optional) — built-in and bundled chat channels such as
|
|
Discord, Feishu, Google Chat, iMessage, Mattermost, Microsoft Teams,
|
|
Telegram, WhatsApp, and more
|
|
5. **Daemon** (optional) — background service so the Gateway starts automatically
|
|
|
|
## CLI onboarding
|
|
|
|
Run in any terminal:
|
|
|
|
```bash
|
|
openclaw onboard
|
|
```
|
|
|
|
Add `--install-daemon` to also install the background service in one step.
|
|
|
|
Full reference: [Onboarding (CLI)](/start/wizard)
|
|
CLI command docs: [`openclaw onboard`](/cli/onboard)
|
|
|
|
## macOS app onboarding
|
|
|
|
Open the OpenClaw app. For local setup, the first-run flow starts the Gateway,
|
|
then opens a Crestodian conversation that detects existing AI access, proposes
|
|
the workspace and config, and applies the plan after approval. Sensitive
|
|
credentials use masked input. Remote setup connects to an already-configured
|
|
Gateway instead.
|
|
|
|
Full reference: [Onboarding (macOS App)](/start/onboarding)
|
|
|
|
## Custom or unlisted providers
|
|
|
|
If your provider is not listed in onboarding, choose **Custom Provider** and
|
|
enter:
|
|
|
|
- Endpoint compatibility: OpenAI-compatible (`/chat/completions`), OpenAI Responses-compatible (`/responses`), Anthropic-compatible (`/messages`), or unknown (probes all three and auto-detects)
|
|
- Base URL and API key (API key is optional if the endpoint does not require one)
|
|
- Model ID and optional model alias
|
|
|
|
Multiple custom endpoints can coexist — each gets its own endpoint ID.
|
|
|
|
## Related
|
|
|
|
- [Getting started](/start/getting-started)
|
|
- [CLI setup reference](/start/wizard-cli-reference)
|