オンボーディング・ウィザード
オンボーディングウィザードを使って、OpenClaw を手動またはガイド付きで設定するためのガイドです。
オンボーディングウィザードは、macOS / Linux / Windows(WSL2 経由を強く推奨)で OpenClaw をセットアップするための**推奨**方法です。ローカル/リモートの Gateway 接続、チャンネル、スキル、ワークスペース既定値の設定をガイドします。
メイン入口:
openclaw onboard
最速で初回チャット:Open Control UI を開く(チャンネル設定不要)。実行:
`openclaw dashboard` を実行してブラウザでチャット。ドキュメント:Dashboard。
Subsequent reconfiguration:
openclaw configure
推奨:Brave Search の API キーを設定し、エージェントが `web_search` を使えるようにする
(`web_fetch` はキー不要)。最も簡単:`openclaw configure --section web`
これにより `tools.web.search.apiKey` が保存されます。ドキュメント:Web Tool。
クイックスタート vs 上級モード
ウィザードは **Quick Start**(既定設定)と **Advanced**(完全制御)から選べます。
**Quick Start** は既定値を維持:
ローカル Gateway(loopback)
既定のワークスペース(または既存を使用)
Gateway ポート **18789**
Gateway 認証は **token**(loopback でも自動生成)
Tailscale 公開は **off**
Telegram / WhatsApp の DM は既定で **allowlist**(番号入力が求められます)
**Advanced** はすべてのステップを表示します(mode、workspace、gateway、channels、daemon、skills)。
ウィザードが行うこと
**ローカルモード(既定)** のガイド内容:
モデル/認証(OpenAI Codex サブの OAuth、Anthropic API キー(推奨)または setup-token(貼り付け)、MiniMax/GLM/Moonshot/AI Gateway の選択肢など)
ワークスペースの場所 + ブートストラップファイル
Gateway 設定(port/bind/auth/Tailscale)
プロバイダ(Telegram、WhatsApp、Discord、Google Chat、Mattermost(プラグイン)、Signal)
デーモン導入(LaunchAgent / systemd user unit)
ヘルスチェック
スキル(推奨)
**リモートモード** は、ローカルクライアントを「別の場所にある Gateway」に接続するよう設定するだけです。リモートホスト側には**何も**インストール/変更しません。
さらに隔離されたエージェント(別ワークスペース+セッション+認証)を追加するには:
openclaw agents add '<name>'
ヒント:`--json` は **non-interactive** を意味しません。スクリプトでは `--non-interactive`(必要に応じて `--workspace`)を使います。
フロー詳細(ローカル)
1. 既存設定の検出
`~/.openclaw/openclaw.json` が存在する場合、**Keep / Modify / Reset** を選べます。
ウィザードを再実行しても、明示的に **Reset**(または `--reset`)を選ばない限り、**何も**削除しません。
設定が無効、または古いキーが含まれる場合、ウィザードは停止して `openclaw doctor` の実行を促します。
Reset は `trash` を使用(`rm` は使用しない)し、範囲を選べます:
- 設定のみ
- 設定 + 資格情報 + セッション
- フルリセット(ワークスペースも削除)
2. モデル/認証
**Anthropic API Key(推奨)**:`ANTHROPIC_API_KEY` があれば使用し、なければキー入力を促します。その後デーモン利用のため保存します。
**Anthropic OAuth(Claude Code CLI)**:macOS では keychain の "Claude Code-credentials" を確認します(launchd にブロックされないよう "Always Allow" を選択)。Linux/Windows では `~/.claude/.credentials.json` があれば再利用します。
**Anthropic Token(setup-token を貼り付け)**:任意のマシンで `claude setup-token` を実行し、トークンを貼り付けます。
**OpenAI Codex サブ(Codex CLI)**:`~/.codex/auth.json` があれば再利用できます。
**OpenAI Codex サブ(OAuth)**:ブラウザフローで `code#state` を貼り付けます。
`agents.defaults.model` が未設定、または `openai/*` の場合は `openai-codex/gpt-5.2` を設定します。
**OpenAI API Key**:`OPENAI_API_KEY` があれば使用し、なければ入力を促します。launchd 用に `~/.openclaw/.env` に保存します。
**OpenCode Zen(マルチモデルプロキシ)**:`OPENCODE_API_KEY`(または `OPENCODE_ZEN_API_KEY`、取得先:opencode.ia/auth)を入力します。
**API Keys**:キー類はウィザードが保存します。
**Vercel AI Gateway(マルチモデルプロキシ)**:`AI_GATEWAY_API_KEY` を入力します。詳細:Vercel AI Gateway
**MiniMax M2.1**:設定は自動生成されます。詳細:MiniMax
**Synthetic(Anthropic 互換)**:`SYNTHETIC_API_KEY` を入力します。詳細:Synthetic
**Moonshot(Kimi K2)**:設定は自動生成されます。
**Kimi Coding**:設定は自動生成されます。詳細:Moonshot AI
**Skip**:まだ認証を設定しません。
検出した選択肢から既定モデルを選ぶ(または手動入力)。
ウィザードはモデルチェックを行い、モード不明や認証不足の場合は警告します。
OAuth 資格情報は `<code1>~/.openclaw/credentials/oauth.json</code1>` に保存され、Auth 設定は `<code2>~/.openclaw/agents/<agentId>/agent/auth-profiles.json</code2>` に保存されます。詳細:<link6>OAuth Concepts</link6>
3. ワークスペース
4. Gateway(ゲートウェイ)
Port、Bind、Auth Mode、Tailscale 公開。
認証の推奨:loopback でも **token** を維持し、ローカルの WS クライアントにも認証を必須にする。
ローカルのすべてのプロセスを信頼できる場合にのみ、認証を無効化します。
loopback 以外へ bind する場合、認証が必須です。
5. チャンネル
WhatsApp:任意の QR ログイン。
Telegram:bot トークン。
Discord:bot トークン。
Google Chat:サービスアカウント JSON + Webhook audience。
Mattermost(プラグイン):bot トークン + Base URL。
Signal:任意で `signal-cli` を導入し、アカウント設定。
iMessage:ローカルの `imsg` CLI パス + DB アクセス。
DM セキュリティ:既定は Pairing モード。初回 DM でコードを送信し、`<code2>openclaw pairing approve <channel> <code>'</code2>` で承認(または allowlist を使用)します。
6. デーモン導入
macOS:LaunchAgent。ログイン済みユーザーセッションが必要。ヘッドレスではカスタム LaunchDaemon を使用します。
Linux(および WSL2 経由の Windows):systemd user unit。ログアウト後も Gateway を維持するため `<code1>loginctl enable-linger <user>'</code1>` を試みます。
sudo が必要な場合があります(`/var/lib/systemd/linger` への書き込み)。まず sudo なしで試します。
**ランタイム選択:** Node(推奨。WhatsApp/Telegram に必要)。Bun は **非推奨**。
7. ヘルスチェック
必要に応じて Gateway を起動し、`openclaw health` を実行します。
ヒント:`openclaw status --deep` は status 出力に Gateway ヘルスプローブを追加します。
8. スキル(推奨)
利用可能なスキルを読み取り、前提条件をチェックします。
Node マネージャを選択:**npm / pnpm**(Bun は非推奨)。
任意の依存関係を導入します(macOS では Homebrew 経由のものもあります)。
9. 完了
サマリーと次のステップ(iOS/Android/macOS アプリを含む)。
GUI が検出できない場合、ブラウザを開く代わりに Control UI 用の SSH ポートフォワード手順を表示します。
Control UI アセットが見つからない場合、ウィザードがビルドを試みます。フォールバックは `pnpm ui:build`。
リモートモード
リモートモードは、ローカルクライアントが別の場所の Gateway に接続するよう設定します。
設定が必要なもの:
リモート Gateway URL(`ws://...`)
リモート Gateway が認証を要求する場合はトークン(推奨)
Notes:
リモート側へのインストールやデーモン変更は行いません。
Gateway が loopback のみの場合、SSH トンネルまたは tailnet を使用します。
検出のヒント:macOS は Bonjour(`dns-sd`)、Linux は Avahi(`avahi-browse`)
別エージェントの追加
`<code1>openclaw agents add <name>'</code1>` を使うと、専用のワークスペース/セッション/認証を持つ別エージェントを作成できます。`<code2>--workspace</code2>` なしで実行するとウィザードが開始されます。
It sets:
`agents.list[].name`
`agents.list[].workspace`
`agents.list[].agentDir`
Notes:
既定のワークスペースは `<code1>~/.openclaw/workspace-<agentId>'</code1>` です。
受信メッセージをルーティングするには `bindings` を追加します(ウィザードでも設定可能)。
non-interactive のフラグ:`--model`、`--agent-dir`、`--bind`、`--non-interactive`。
Non-Interactive モード
自動化やスクリプトによるオンボーディングでは `--non-interactive` を使用します:
openclaw onboard --non-interactive \ --mode local \ --auth-choice gemini-api-key \ --gemini-api-key "$GEMINI_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback
機械可読なサマリーが必要なら `--json` を追加します。
Z.AI の例:
openclaw onboard --non-interactive \ --mode local \ --auth-choice zai-api-key \ --zai-api-key "$Z_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback
Vercel AI Gateway の例:
openclaw onboard --non-interactive \ --mode local \ --auth-choice ai-gateway-api-key \ --ai-gateway-api-key "$AI_GATEWAY_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback
Moonshot の例:
openclaw onboard --non-interactive \ --mode local \ --auth-choice moonshot-api-key \ --moonshot-api-key "$MOONSHOT_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback
Synthetic の例:
openclaw onboard --non-interactive \ --mode local \ --auth-choice synthetic-api-key \ --synthetic-api-key "$SYNTHETIC_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback
OpenCode Zen の例:
openclaw onboard --non-interactive \ --mode local \ --auth-choice opencode-zen \ --opencode-zen-api-key "$OPENCODE_API_KEY" \ --gateway-port 18789 \ --gateway-bind loopback
エージェント追加(Non-interactive)の例:
openclaw agents add work \ --workspace ~/.openclaw/workspace-work \ --model openai/gpt-5.2 \ --bind whatsapp:biz \ --non-interactive \ --json
Gateway ウィザード RPC
Gateway は RPC(`wizard.start`、`wizard.next`、`wizard.cancel`、`wizard.status`)としてウィザードフローを公開します。クライアント(macOS アプリ、Control UI)はオンボーディングロジックを再実装せずにステップを描画できます。
Signal セットアップ(signal-cli)
ウィザードは GitHub releases から `signal-cli` をインストールできます:
適切な release アセットをダウンロード。
`<code1>~/.openclaw/tools/signal-cli/<version>/</code1>` に保存。
設定に `channels.signal.cliPath` を書き込み。
Notes:
JVM ビルドには **Java 21** が必要です。
可能ならネイティブビルドを優先します。
Windows は WSL2 を使用し、WSL 内の Linux フローで導入します。
ウィザードが書き込む内容
`~/.openclaw/openclaw.json` の典型的な項目:
`agents.defaults.workspace`
`agents.defaults.model` / `models.providers` (if Minimax)
`gateway.*` (mode, bind, auth, Tailscale)
`channels.telegram.botToken`, `channels.discord.token`, `channels.signal.*`, `channels.imessage.*`
必要に応じてチャンネル allowlist(Slack/Discord/Matrix/Teams。可能なら名前→ID に解決)。
`skills.install.nodeManager`
`wizard.*` (lastRunAt, lastRunVersion, lastRunCommit, lastRunCommand, lastRunMode)
`openclaw agents add` は `agents.list[]` と、必要に応じて `bindings` を書き込みます。
WhatsApp の資格情報は `<code1>~/.openclaw/credentials/whatsapp/<accountId>/</code1>` に保存されます。セッションは `<code2>~/.openclaw/agents/<agentId>/sessions/</code2>` に保存されます。
一部チャンネルはプラグイン提供です。選択すると、設定の前に導入(npm またはローカルパス)を促します。