メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

これは openclaw onboard の完全なリファレンスです。 高レベルの概要は、オンボーディング (CLI) を参照してください。

​
フローの詳細 (ローカルモード)

1

既存設定の検出

  • ~/.openclaw/openclaw.json が存在する場合は、現在の値を保持、確認して更新、または セットアップ前にリセット を選択します。
  • オンボーディングを再実行しても、明示的に リセット を選択しない限り何も消去されません (または --reset を渡した場合)。
  • CLI の --reset はデフォルトで config+creds+sessions です。workspace も削除するには --reset-scope full を使用します。
  • 設定が無効、またはレガシーキーを含む場合、ウィザードは停止し、続行する前に openclaw doctor を実行するよう求めます。
  • リセットでは trash を使用し (rm は使用しません)、次のスコープを提示します。
    • 設定のみ
    • 設定 + 認証情報 + セッション
    • 完全リセット (workspace も削除)
2

モデル/認証

  • Anthropic API キー: 存在する場合は ANTHROPIC_API_KEY を使用し、なければキーの入力を求め、その後デーモンで使用できるよう保存します。
  • Anthropic API キー: オンボーディング/設定で推奨される Anthropic アシスタントの選択肢です。
  • Anthropic setup-token: OpenClaw は現在、利用可能な場合は Claude CLI の再利用を優先しますが、オンボーディング/設定では引き続き利用できます。
  • OpenAI Code (Codex) サブスクリプション (OAuth): ブラウザーフローです。code#state を貼り付けます。
    • モデルが未設定、またはすでに OpenAI 系の場合、Codex ランタイム経由で agents.defaults.model を openai/gpt-5.5 に設定します。
  • OpenAI Code (Codex) サブスクリプション (デバイスペアリング): 有効期間の短いデバイスコードを使うブラウザーペアリングフローです。
    • モデルが未設定、またはすでに OpenAI 系の場合、Codex ランタイム経由で agents.defaults.model を openai/gpt-5.5 に設定します。
  • 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 + Local、Cloud only、または Local only を提示します。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 標準または Step Plan 向けに、設定が自動で書き込まれます。
  • 標準には現在 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 キー保存モードは、デフォルトでプレーンテキストの認証プロファイル値です。代わりに環境変数ベースの参照を保存するには --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
ヘッドレス/サーバー向けのヒント: ブラウザーのあるマシンで OAuth を完了し、その後 そのエージェントの auth-profiles.json (例: ~/.openclaw/agents/<agentId>/agent/auth-profiles.json、または対応する $OPENCLAW_STATE_DIR/... パス) を Gateway ホストにコピーします。credentials/oauth.json はレガシーのインポート元にすぎません。
3

Workspace

  • デフォルトは ~/.openclaw/workspace です (設定可能)。
  • エージェントのブートストラップ儀式に必要な workspace ファイルをシードします。
  • 完全な workspace レイアウト + バックアップガイド: エージェント workspace
4

Gateway

  • ポート、bind、認証モード、Tailscale 公開。
  • 認証の推奨: local loopback であっても トークン を保持し、ローカル WS クライアントが認証を必須にするようにします。
  • トークンモードでは、対話型セットアップで次を提示します。
    • プレーンテキストトークンを生成/保存 (デフォルト)
    • SecretRef を使用 (オプトイン)
    • クイックスタートでは、オンボーディングのプローブ/ダッシュボードのブートストラップのために、env、file、exec プロバイダーにまたがって既存の gateway.auth.token SecretRef を再利用します。
    • その SecretRef が設定されているが解決できない場合、オンボーディングはランタイム認証を静かに劣化させるのではなく、明確な修正メッセージを出して早期に失敗します。
  • パスワードモードでは、対話型セットアップはプレーンテキストまたは SecretRef 保存もサポートします。
  • 非対話型トークン SecretRef パス: --gateway-token-ref-env <ENV_VAR>。
    • オンボーディングプロセス環境に、空でない環境変数が必要です。
    • --gateway-token と組み合わせることはできません。
  • すべてのローカルプロセスを完全に信頼できる場合にのみ認証を無効化してください。
  • local loopback 以外の bind では引き続き認証が必要です。
5

チャンネル

  • WhatsApp: 任意の QR ログイン。
  • Telegram: bot トークン。
  • Discord: bot トークン。
  • Google Chat: サービスアカウント JSON + webhook audience。
  • Mattermost (Plugin): bot トークン + ベース URL。
  • Signal: 任意の signal-cli インストール + アカウント設定。
  • iMessage: imsg CLI パス + Messages DB アクセス。Gateway が Mac 以外で動作する場合は SSH ラッパーを使用します。
  • DM セキュリティ: デフォルトはペアリングです。最初の DM でコードが送信されます。openclaw pairing approve <channel> <code> で承認するか、許可リストを使用します。
6

Web 検索

  • Brave、DuckDuckGo、Exa、Firecrawl、Gemini、Grok、Kimi、MiniMax Search、Ollama Web Search、Perplexity、SearXNG、Tavily などのサポート対象プロバイダーを選択します (またはスキップします)。
  • API ベースのプロバイダーは、素早いセットアップのために環境変数または既存設定を使用できます。キー不要のプロバイダーは、それぞれのプロバイダー固有の前提条件を使用します。
  • --skip-search でスキップします。
  • 後で設定: openclaw configure --section web。
7

デーモンのインストール

  • macOS: LaunchAgent
    • ログイン済みユーザーセッションが必要です。ヘッドレスでは、カスタム LaunchDaemon (同梱されていません) を使用します。
  • Linux (および WSL2 経由の Windows): systemd ユーザーユニット
    • オンボーディングは、ログアウト後も Gateway が起動し続けるように loginctl enable-linger <user> で lingering の有効化を試みます。
    • sudo を求める場合があります (/var/lib/systemd/linger に書き込みます)。まず sudo なしで試行します。
  • ランタイム選択: Node (推奨。WhatsApp/Telegram には必須)。Bun は 推奨されません。
  • トークン認証にトークンが必要で、gateway.auth.token が SecretRef 管理されている場合、デーモンのインストールはそれを検証しますが、解決済みのプレーンテキストトークン値をスーパーバイザーサービス環境メタデータに永続化しません。
  • トークン認証にトークンが必要で、設定されたトークン SecretRef が未解決の場合、デーモンのインストールは実行可能なガイダンス付きでブロックされます。
  • gateway.auth.token と gateway.auth.password の両方が設定されており、gateway.auth.mode が未設定の場合、モードが明示的に設定されるまでデーモンのインストールはブロックされます。
8

ヘルスチェック

  • Gateway を起動し (必要な場合)、openclaw health を実行します。
  • ヒント: openclaw status --deep は、サポートされている場合のチャンネルプローブを含め、ライブ Gateway ヘルスプローブをステータス出力に追加します (到達可能な Gateway が必要)。
9

Skills (推奨)

  • 利用可能な Skills を読み取り、要件を確認します。
  • ノードマネージャーを選択できます: npm / pnpm (bun は推奨されません)。
  • 任意の依存関係をインストールします (macOS では Homebrew を使うものもあります)。
10

完了

  • 概要 + 次のステップ。Terminal、Browser、または後で実行するための エージェントをどのように孵化させますか? プロンプトを含みます。
GUI が検出されない場合、オンボーディングはブラウザーを開く代わりに Control UI 用の SSH ポートフォワード手順を出力します。 Control UI アセットがない場合、オンボーディングはそれらのビルドを試みます。フォールバックは pnpm ui:build です (UI 依存関係を自動インストールします)。

​
非対話型モード

オンボーディングを自動化またはスクリプト化するには --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 は相互排他的です。
--json は非対話型モードを意味しません。スクリプトでは --non-interactive (および --workspace) を使用してください。
プロバイダー固有のコマンド例は 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 リリースから signal-cli をインストールできます。
  • 適切なリリースアセットをダウンロードします。
  • ~/.openclaw/tools/signal-cli/<version>/ 配下に保存します。
  • 設定に channels.signal.cliPath を書き込みます。
注記:
  • JVM ビルドには Java 21 が必要です。
  • 利用可能な場合はネイティブビルドが使用されます。
  • Windows は WSL2 を使用します。signal-cli のインストールは WSL 内の Linux フローに従います。

​
ウィザードが書き込む内容

~/.openclaw/openclaw.json の代表的なフィールド:
  • agents.defaults.workspace
  • agents.defaults.model / models.providers (Minimax が選択された場合)
  • tools.profile (未設定の場合、ローカルオンボーディングのデフォルトは "coding" です。既存の明示的な値は保持されます)
  • gateway.* (モード、バインド、認証、tailscale)
  • session.dmScope (動作の詳細: CLI セットアップリファレンス)
  • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
  • プロンプト中にオプトインした場合のチャンネル許可リスト (Slack/Discord/Matrix/Microsoft Teams) (可能な場合、名前は ID に解決されます)。
  • skills.install.nodeManager
    • setup --node-manager は npm、pnpm、または bun を受け付けます。
    • 手動設定では、skills.install.nodeManager を直接設定することで引き続き yarn を使用できます。
  • wizard.lastRunAt
  • wizard.lastRunVersion
  • wizard.lastRunCommit
  • wizard.lastRunCommand
  • wizard.lastRunMode
openclaw agents add は agents.list[] と任意の bindings を書き込みます。 WhatsApp の認証情報は ~/.openclaw/credentials/whatsapp/<accountId>/ に配置されます。 セッションは ~/.openclaw/agents/<agentId>/sessions/ に保存されます。 一部のチャンネルは Plugin として提供されます。セットアップ中にそのいずれかを選択すると、オンボーディングでは、設定できるようになる前にそれをインストールするよう求められます (npm またはローカルパス)。

​
関連ドキュメント