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 キーは auth プロファイル内のプレーンテキスト値として保持されます。
• --secret-input-mode ref は、プレーンテキストのキー保存ではなく参照モードを有効にします。 対話型セットアップでは、次のいずれかを選択できます。
  • 環境変数参照（例: keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }）
  • provider エイリアス + id を使用する構成済み provider 参照（file または exec）
• 対話型参照モードでは、保存前に高速な事前検証が実行されます。
  • Env refs: 現在のオンボーディング環境で、変数名 + 空でない値を検証します。
  • Provider refs: provider 構成を検証し、要求された id を解決します。
  • 事前検証に失敗した場合、オンボーディングはエラーを表示し、再試行できるようにします。
• 非対話型モードでは、--secret-input-mode ref は env バックのみです。
  • オンボーディングプロセス環境で provider 環境変数を設定します。
  • インラインキー フラグ（例: --openai-api-key）では、その環境変数が設定されている必要があります。設定されていない場合、オンボーディングは即座に失敗します。
  • カスタム provider の場合、非対話型 ref モードは models.providers.<id>.apiKey を { source: "env", provider: "default", id: "CUSTOM_API_KEY" } として保存します。
  • そのカスタム provider の場合、--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
• wizard.securityAcknowledgedAt

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