oclaw/openclaw/docs/start/onboarding-overview.md
oliver dbbe3add6a 重构主控编排与运行时预热链路,统一工作区提示词/专家调度协议并补齐 wiki 记忆注入与写回闭环。
同时收敛启动与运维脚本默认行为(含 wiki worker)、更新 Admin 可观测性与相关测试,降低首轮时延并提高运行稳定性。

Made-with: Cursor
2026-04-26 08:34:33 +08:00

2.4 KiB

summary read_when title sidebarTitle
Overview of OpenClaw onboarding options and flows
Choosing an onboarding path
Setting up a new environment
Onboarding Overview Onboarding Overview

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 in the app
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 BlueBubbles, Discord, Feishu, Google Chat, Mattermost, Microsoft Teams, Telegram, WhatsApp, and more
  5. Daemon (optional) — background service so the Gateway starts automatically

CLI onboarding

Run in any terminal:

openclaw onboard

Add --install-daemon to also install the background service in one step.

Full reference: Onboarding (CLI) CLI command docs: openclaw onboard

macOS app onboarding

Open the OpenClaw app. The first-run wizard walks you through the same steps with a visual interface.

Full reference: Onboarding (macOS App)

Custom or unlisted providers

If your provider is not listed in onboarding, choose Custom Provider and enter:

  • API compatibility mode (OpenAI-compatible, Anthropic-compatible, or auto-detect)
  • Base URL and API key
  • Model ID and optional alias

Multiple custom endpoints can coexist — each gets its own endpoint ID.