CLI セットアップリファレンス

このページは openclaw onboard の完全なリファレンスです。 短いガイドについては、オンボーディング (CLI) を参照してください。

ウィザードが行うこと

ローカルモード (デフォルト) では、次の項目を順に設定します。

• モデルと認証のセットアップ (OpenAI Code サブスクリプション OAuth、Anthropic Claude CLI または API キー、さらに MiniMax、GLM、Ollama、Moonshot、StepFun、AI Gateway オプション)
• ワークスペースの場所とブートストラップファイル
• Gateway 設定 (ポート、バインド、認証、Tailscale)
• チャネルとプロバイダー (Telegram、WhatsApp、Discord、Google Chat、Mattermost、Signal、iMessage、およびその他の同梱チャネル Plugin)
• デーモンのインストール (LaunchAgent、systemd ユーザーユニット、または Startup フォルダーへのフォールバック付きのネイティブ Windows Scheduled Task)
• ヘルスチェック
• Skills のセットアップ

リモートモードでは、このマシンが別の場所にある Gateway へ接続するように設定します。 リモートホスト上のものをインストールしたり変更したりすることはありません。

ローカルフローの詳細

リモートモードの詳細

リモートモードでは、このマシンが別の場所にある Gateway へ接続するように設定します。

設定する内容:

• リモート Gateway URL (ws://...)
• リモート Gateway 認証が必要な場合のトークン (推奨)

認証とモデルのオプション

モデルの動作:

• 検出されたオプションからデフォルトモデルを選択するか、プロバイダーとモデルを手動で入力します。
• カスタムプロバイダーのオンボーディングは、一般的なモデル ID について画像サポートを推論し、モデル名が不明な場合にのみ確認します。
• オンボーディングがプロバイダー認証の選択から開始された場合、モデルピッカーは そのプロバイダーを自動的に優先します。Volcengine と BytePlus では、同じ優先設定が それぞれの coding-plan バリアント (volcengine-plan/*, byteplus-plan/*) にも一致します。
• その優先プロバイダーフィルターが空になる場合、ピッカーはモデルなしを表示する代わりに 完全なカタログにフォールバックします。
• ウィザードはモデルチェックを実行し、設定されたモデルが不明、または認証が不足している場合に警告します。

認証情報とプロファイルのパス:

• 認証プロファイル (API キー + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• レガシー OAuth インポート: ~/.openclaw/credentials/oauth.json

認証情報ストレージモード:

• デフォルトのオンボーディング動作では、API キーが認証プロファイル内のプレーンテキスト値として永続化されます。
• --secret-input-mode ref は、プレーンテキストキー保存の代わりに参照モードを有効にします。 対話型セットアップでは、次のいずれかを選択できます。
  • 環境変数 ref (例: keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • 設定済み provider ref (file または exec) と provider エイリアス + id
• 対話型の参照モードでは、保存前に高速な事前検証が実行されます。
  • Env refs: 現在のオンボーディング環境で、変数名 + 空でない値を検証します。
  • Provider refs: プロバイダー設定を検証し、要求された id を解決します。
  • 事前検証に失敗した場合、オンボーディングはエラーを表示し、再試行できるようにします。
• 非対話型モードでは、--secret-input-mode ref は env backed のみです。
  • オンボーディングプロセス環境でプロバイダー環境変数を設定します。
  • インラインキーフラグ (例: --openai-api-key) では、その環境変数が設定されている必要があります。設定されていない場合、オンボーディングはすぐに失敗します。
  • カスタムプロバイダーでは、非対話型の ref モードは models.providers.<id>.apiKey を { source: "env", provider: "default", id: "CUSTOM_API_KEY" } として保存します。
  • そのカスタムプロバイダーの場合、--custom-api-key では CUSTOM_API_KEY が設定されている必要があります。設定されていない場合、オンボーディングはすぐに失敗します。
• Gateway 認証情報は、対話型セットアップでプレーンテキストと SecretRef の選択肢をサポートします。
  • トークンモード: プレーンテキストトークンを生成して保存 (デフォルト) または SecretRef を使用。
  • パスワードモード: プレーンテキストまたは SecretRef。
• 非対話型のトークン SecretRef パス: --gateway-token-ref-env <ENV_VAR>。
• 既存のプレーンテキストセットアップは、変更なしで引き続き動作します。

出力と内部

~/.openclaw/openclaw.json の典型的なフィールド:

• agents.defaults.workspace
• --skip-bootstrap が渡された場合の agents.defaults.skipBootstrap
• agents.defaults.model / models.providers (Minimax を選択した場合)
• tools.profile (未設定の場合、ローカルのオンボーディングは "coding" をデフォルトにします。既存の明示的な値は保持されます)
• gateway.* (mode、bind、auth、tailscale)
• session.dmScope (未設定の場合、ローカルのオンボーディングはこれを per-channel-peer にデフォルト設定します。既存の明示的な値は保持されます)
• 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/ の下に保存されます。

Gateway ウィザード RPC:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

クライアント (macOS アプリと Control UI) は、オンボーディングロジックを再実装せずにステップを表示できます。

Signal セットアップの動作:

• 適切なリリースアセットをダウンロードします
• ~/.openclaw/tools/signal-cli/<version>/ の下に保存します
• 設定に channels.signal.cliPath を書き込みます
• JVM ビルドには Java 21 が必要です
• 利用可能な場合はネイティブビルドが使用されます
• Windows では WSL2 を使用し、WSL 内で Linux の signal-cli フローに従います

関連ドキュメント

• オンボーディングハブ: オンボーディング (CLI)
• 自動化とスクリプト: CLI 自動化
• コマンドリファレンス: openclaw onboard