Technical reference
オンボーディングリファレンス
これは openclaw onboard の完全なリファレンスです。
概要は オンボーディング (CLI) を参照してください。
フロー詳細 (ローカルモード)
既存設定の検出
~/.openclaw/openclaw.jsonが存在する場合は、保持 / 変更 / リセット を選択します。- オンボーディングを再実行しても、明示的に リセット を選択しない限り何も消去されません
(
--resetを渡した場合も同様です)。 - CLI の
--resetはデフォルトでconfig+creds+sessionsです。ワークスペースも削除するには--reset-scope fullを使用します。 - 設定が無効、またはレガシーキーを含む場合、ウィザードは停止し、続行する前に
openclaw doctorを実行するよう求めます。 - リセットは
trashを使用し (rmは使いません)、次のスコープを提示します。- 設定のみ
- 設定 + 認証情報 + セッション
- 完全リセット (ワークスペースも削除)
モデル/認証
- Anthropic APIキー: 存在する場合は
ANTHROPIC_API_KEYを使用し、なければキーの入力を求め、その後デーモンで使用するため保存します。 - Anthropic APIキー: オンボーディング/設定で推奨される Anthropic アシスタントの選択肢です。
- Anthropic setup-token: OpenClaw は現在、利用可能な場合 Claude CLI の再利用を優先しますが、オンボーディング/設定では引き続き利用できます。
- OpenAI Code (Codex) サブスクリプション (OAuth): ブラウザーフローです。
code#stateを貼り付けます。- モデルが未設定、またはすでに OpenAI 系の場合、
agents.defaults.modelをopenai-codex/gpt-5.5に設定します。
- モデルが未設定、またはすでに OpenAI 系の場合、
- OpenAI Code (Codex) サブスクリプション (デバイスペアリング): 短時間有効なデバイスコードを使うブラウザーペアリングフローです。
- モデルが未設定、またはすでに OpenAI 系の場合、
agents.defaults.modelをopenai-codex/gpt-5.5に設定します。
- モデルが未設定、またはすでに OpenAI 系の場合、
- OpenAI APIキー: 存在する場合は
OPENAI_API_KEYを使用し、なければキーの入力を求め、その後認証プロファイルに保存します。- モデルが未設定、
openai/*、またはopenai-codex/*の場合、agents.defaults.modelをopenai/gpt-5.5に設定します。
- モデルが未設定、
- xAI (Grok) APIキー:
XAI_API_KEYの入力を求め、xAI をモデルプロバイダーとして設定します。 - OpenCode:
OPENCODE_API_KEY(またはOPENCODE_ZEN_API_KEY。https://opencode.ai/auth で取得) の入力を求め、Zen または Go カタログを選べるようにします。 - Ollama: 最初に クラウド + ローカル、クラウドのみ、または ローカルのみ を提示します。
Cloud onlyはOLLAMA_API_KEYの入力を求め、https://ollama.comを使用します。ホストベースのモードでは Ollama ベースURLの入力を求め、利用可能なモデルを検出し、必要に応じて選択されたローカルモデルを自動で pull します。Cloud + Localは、その Ollama ホストがクラウドアクセスにサインインしているかも確認します。 - 詳細: Ollama
- APIキー: キーを保存します。
- Vercel AI Gateway (マルチモデルプロキシ):
AI_GATEWAY_API_KEYの入力を求めます。 - 詳細: Vercel AI Gateway
- Cloudflare AI Gateway: Account ID、Gateway ID、
CLOUDFLARE_AI_GATEWAY_API_KEYの入力を求めます。 - 詳細: Cloudflare AI Gateway
- MiniMax: 設定は自動で書き込まれます。ホスト型のデフォルトは
MiniMax-M2.7です。 APIキー設定ではminimax/...を使用し、OAuth 設定ではminimax-portal/...を使用します。 - 詳細: MiniMax
- StepFun: 設定は、中国またはグローバルエンドポイント上の StepFun standard または Step Plan 向けに自動で書き込まれます。
- Standard には現在
step-3.5-flashが含まれ、Step Plan にはstep-3.5-flash-2603も含まれます。 - 詳細: StepFun
- Synthetic (Anthropic互換):
SYNTHETIC_API_KEYの入力を求めます。 - 詳細: Synthetic
- Moonshot (Kimi K2): 設定は自動で書き込まれます。
- Kimi Coding: 設定は自動で書き込まれます。
- 詳細: Moonshot AI (Kimi + Kimi Coding)
- スキップ: まだ認証は設定されません。
- 検出された選択肢からデフォルトモデルを選択します (または provider/model を手動で入力します)。最高の品質とより低いプロンプトインジェクションリスクのため、プロバイダースタックで利用可能な最強の最新世代モデルを選択してください。
- オンボーディングはモデルチェックを実行し、設定されたモデルが不明、または認証が不足している場合に警告します。
- APIキーの保存モードは、デフォルトでプレーンテキストの auth-profile 値です。代わりに env ベースの参照を保存するには
--secret-input-mode refを使用します (例:keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })。 - 認証プロファイルは
~/.openclaw/agents/<agentId>/agent/auth-profiles.json(APIキー + OAuth) にあります。~/.openclaw/credentials/oauth.jsonはレガシーのインポート専用です。 - 詳細: /concepts/oauth
ワークスペース
- デフォルトは
~/.openclaw/workspaceです (設定可能)。 - エージェントのブートストラップ儀式に必要なワークスペースファイルを配置します。
- 完全なワークスペースレイアウト + バックアップガイド: エージェントワークスペース
Gateway
- ポート、bind、認証モード、tailscale 公開。
- 認証の推奨: local WS クライアントにも認証を必須にするため、loopback でも トークン を維持してください。
- トークンモードでは、対話型セットアップで次を提示します。
- プレーンテキストトークンを生成/保存 (デフォルト)
- SecretRef を使用 (オプトイン)
- クイックスタートは、オンボーディングのプローブ/ダッシュボードブートストラップ向けに、
env、file、execプロバイダー全体で既存のgateway.auth.tokenSecretRefs を再利用します。 - その SecretRef が設定されているが解決できない場合、オンボーディングはランタイム認証を黙って弱めるのではなく、明確な修正メッセージとともに早期に失敗します。
- パスワードモードでは、対話型セットアップはプレーンテキストまたは SecretRef ストレージもサポートします。
- 非対話型トークン SecretRef パス:
--gateway-token-ref-env <ENV_VAR>。- オンボーディングプロセス環境に空でない env var が必要です。
--gateway-tokenと組み合わせることはできません。
- すべてのローカルプロセスを完全に信頼できる場合にのみ、認証を無効化してください。
- 非 loopback bind では引き続き認証が必要です。
チャンネル
- WhatsApp: 任意の QR ログイン。
- Telegram: bot token。
- Discord: bot token。
- Google Chat: サービスアカウント JSON + webhook audience。
- Mattermost (plugin): bot token + ベースURL。
- Signal: 任意の
signal-cliインストール + アカウント設定。 - BlueBubbles: iMessage には推奨。server URL + password + webhook。
- iMessage: レガシー
imsgCLI パス + DB アクセス。 - DM セキュリティ: デフォルトはペアリングです。最初の DM がコードを送信します。
openclaw pairing approve <channel> <code>で承認するか、許可リストを使用します。
Web検索
- Brave、DuckDuckGo、Exa、Firecrawl、Gemini、Grok、Kimi、MiniMax Search、Ollama Web Search、Perplexity、SearXNG、Tavily などのサポート対象プロバイダーを選択します (またはスキップします)。
- API ベースのプロバイダーは、素早いセットアップのために env vars または既存設定を使用できます。キー不要のプロバイダーは、代わりに各プロバイダー固有の前提条件を使用します。
--skip-searchでスキップします。- 後で設定:
openclaw configure --section web。
デーモンインストール
- macOS: LaunchAgent
- ログイン済みのユーザーセッションが必要です。ヘッドレスの場合は、カスタム LaunchDaemon (同梱されていません) を使用します。
- Linux (および WSL2 経由の Windows): systemd ユーザーユニット
- オンボーディングは、ログアウト後も Gateway が稼働し続けるように
loginctl enable-linger <user>で lingering を有効化しようとします。 - sudo を求める場合があります (
/var/lib/systemd/lingerに書き込みます)。最初は sudo なしで試します。
- オンボーディングは、ログアウト後も Gateway が稼働し続けるように
- ランタイム選択: Node (推奨。WhatsApp/Telegram には必須)。Bun は 推奨されません。
- トークン認証でトークンが必要で、
gateway.auth.tokenが SecretRef 管理の場合、デーモンインストールはそれを検証しますが、解決済みプレーンテキストトークン値を supervisor サービス環境メタデータに永続化しません。 - トークン認証でトークンが必要で、設定済みのトークン SecretRef が未解決の場合、デーモンインストールは実行可能なガイダンスとともにブロックされます。
gateway.auth.tokenとgateway.auth.passwordの両方が設定され、gateway.auth.modeが未設定の場合、モードが明示的に設定されるまでデーモンインストールはブロックされます。
ヘルスチェック
- Gateway を起動し (必要な場合)、
openclaw healthを実行します。 - ヒント:
openclaw status --deepは、サポートされる場合にチャンネルプローブを含め、ライブ gateway ヘルスプローブをステータス出力に追加します (到達可能な gateway が必要です)。
Skills (推奨)
- 利用可能な skills を読み取り、要件を確認します。
- node manager を選べます: npm / pnpm (bun は推奨されません)。
- 任意の依存関係をインストールします (一部は macOS で Homebrew を使用します)。
完了
- 追加機能向けの iOS/Android/macOS アプリを含む、概要 + 次の手順。
非対話型モード
オンボーディングを自動化またはスクリプト化するには --non-interactive を使用します。
openclaw onboard --non-interactive \
--mode local \
--auth-choice apiKey \
--anthropic-api-key "$ANTHROPIC_API_KEY" \
--gateway-port 18789 \
--gateway-bind loopback \
--install-daemon \
--daemon-runtime node \
--skip-skills
機械可読な概要には --json を追加します。
非対話型モードでの Gateway トークン SecretRef:
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
--mode local \
--auth-choice skip \
--gateway-auth token \
--gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN
--gateway-token と --gateway-token-ref-env は相互に排他的です。
プロバイダー固有のコマンド例は CLI 自動化 にあります。 フラグの意味と手順の順序には、このリファレンスページを使用してください。
エージェントを追加 (非対話型)
openclaw agents add work \
--workspace ~/.openclaw/workspace-work \
--model openai/gpt-5.5 \
--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 をインストールできます。
- 適切なリリースアセットをダウンロードします。
~/.openclaw/tools/signal-cli/<version>/配下に保存します。- 設定に
channels.signal.cliPathを書き込みます。
注記:
- JVM ビルドには Java 21 が必要です。
- 利用可能な場合はネイティブビルドが使用されます。
- Windows は WSL2 を使用します。signal-cli インストールは WSL 内の Linux フローに従います。
ウィザードが書き込む内容
~/.openclaw/openclaw.json の典型的なフィールド:
agents.defaults.workspaceagents.defaults.model/models.providers(Minimax を選択した場合)tools.profile(ローカルのオンボーディングでは、未設定の場合は"coding"がデフォルトになります。既存の明示的な値は保持されます)gateway.*(mode、bind、auth、tailscale)session.dmScope(動作の詳細: CLI セットアップリファレンス)channels.telegram.botToken、channels.discord.token、channels.matrix.*、channels.signal.*、channels.imessage.*- プロンプト中にオプトインした場合のチャンネル許可リスト (Slack/Discord/Matrix/Microsoft Teams) (可能な場合、名前は ID に解決されます)。
skills.install.nodeManagersetup --node-managerはnpm、pnpm、またはbunを受け付けます。- 手動設定では、
skills.install.nodeManagerを直接設定することで引き続きyarnを使用できます。
wizard.lastRunAtwizard.lastRunVersionwizard.lastRunCommitwizard.lastRunCommandwizard.lastRunMode
openclaw agents add は agents.list[] と任意の bindings を書き込みます。
WhatsApp の認証情報は ~/.openclaw/credentials/whatsapp/<accountId>/ 配下に配置されます。
セッションは ~/.openclaw/agents/<agentId>/sessions/ 配下に保存されます。
一部のチャンネルは plugins として提供されます。セットアップ中にいずれかを選択すると、設定できるようになる前に、オンボーディングでそのインストール (npm またはローカルパス) を求められます。
関連ドキュメント
- オンボーディング概要: オンボーディング (CLI)
- macOS アプリのオンボーディング: オンボーディング
- 設定リファレンス: Gateway 設定
- プロバイダー: WhatsApp、Telegram、Discord、Google Chat、Signal、BlueBubbles (iMessage)、iMessage (レガシー)
- Skills: Skills、Skills 設定