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

このページでは、段階的なオンボーディングの動作、出力、内部実装について説明します。 手順については、オンボーディング（CLI）を参照してください。CLI フラグの完全な リファレンス（すべての --flag、非対話型の例、プロバイダー固有の コマンド）については、openclaw onboardを参照してください。

ウィザードの機能

ローカルモード（デフォルト）では、次の手順を案内します。

• モデルと認証のセットアップ（Anthropic、OpenAI Code サブスクリプション OAuth、xAI、OpenCode、カスタムエンドポイント、およびその他のプロバイダー所有の認証フロー）
• ワークスペースの場所とブートストラップファイル
• Gateway の設定（ポート、バインド、認証、Tailscale）
• チャンネルとプロバイダー（Discord、Feishu、Google Chat、iMessage、Mattermost、Microsoft Teams、QQ Bot、Signal、Slack、Telegram、WhatsApp、およびその他のバンドル済みまたは Plugin のチャンネル）
• Web 検索プロバイダー（任意）
• デーモンのインストール（LaunchAgent、systemd ユーザーユニット、またはスタートアップフォルダーへのフォールバックを備えた Windows ネイティブの Scheduled Task）
• ヘルスチェック
• Skills のセットアップ

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

ローカルフローの詳細

リモートモードの詳細

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

設定する項目：

• リモート Gateway の URL（ws://... または wss://...）
• リモート Gateway の設定に一致するトークン、パスワード、または認証なし

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

対話型オンボーディングでプロバイダーのセットアップ手順が失敗した場合（たとえば、ローカルでサインインしていない状態で CLI の再利用オプションを選択した場合）、 ウィザードは終了せず、エラーを表示してプロバイダー選択画面に戻ります。 明示的な --auth-choice の実行は、自動化のため引き続き即座に失敗します。

モデルの動作:

• 検出された選択肢からデフォルトモデルを選ぶか、プロバイダーとモデルを手動で入力します。
• プロバイダー認証の選択からオンボーディングを開始すると、モデル選択画面では そのプロバイダーが自動的に優先されます。Volcengine と BytePlus では、この優先設定は それぞれのコーディングプランのバリアント（volcengine-plan/*、 byteplus-plan/*）にも一致します。
• 優先プロバイダーによる絞り込み結果が空になる場合、モデルを何も表示しないのではなく、 完全なカタログにフォールバックします。
• ウィザードはモデルチェックを実行し、設定されたモデルが不明、または認証がない場合に警告します。

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

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

認証情報の保存モード:

• デフォルトのオンボーディング動作では、API キーをプレーンテキスト値として認証プロファイルに保存します。
• --secret-input-mode ref を使用すると、プレーンテキストでのキー保存ではなく参照モードが有効になります。 対話型セットアップでは、次のいずれかを選択できます。
  • 環境変数参照（例: keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }）
  • プロバイダーのエイリアス + ID を指定した設定済みプロバイダー参照（file または exec）
• 対話型の参照モードでは、保存前に簡易的な事前検証を実行します。
  • 環境変数参照: 現在のオンボーディング環境で、変数名と空でない値を検証します。
  • プロバイダー参照: プロバイダー設定を検証し、要求された ID を解決します。
  • 事前検証に失敗した場合、オンボーディングはエラーを表示し、再試行できるようにします。
• 非対話型モードでは、--secret-input-mode ref は環境変数のみを参照します。
  • オンボーディングプロセスの環境に、プロバイダーの環境変数を設定します。
  • インラインキーフラグ（例: --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.*（モード、バインド、認証、Tailscale）
• session.dmScope（未設定の場合、ローカルオンボーディングではデフォルトで per-channel-peer に設定。既存の明示的な値は維持）
• channels.telegram.botToken、channels.discord.token、channels.matrix.*、channels.signal.*、channels.imessage.*
• プロンプト中にオプトインした場合のチャンネル許可リスト（Discord、iMessage、Signal、Slack、Telegram、WhatsApp）。Discord と Slack では、入力された名前も 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>/agent/openclaw-agent.sqlite に保存されます。 ~/.openclaw/agents/<agentId>/sessions/ ディレクトリは、レガシー移行の 入力およびアーカイブ／サポート用アーティファクトに使用されます。

非対話型セットアップ

--non-interactive には --accept-risk が必要です（エージェントは強力であり、 システム全体へのアクセスにはリスクがあることを了承します）。

openclaw onboard --non-interactive --accept-risk \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY"

全フラグのリファレンスとプロバイダー固有の例: openclaw onboard、CLI 自動化。

Gateway ウィザード RPC

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

クライアント（macOS アプリおよび Control UI）は、オンボーディングロジックを再実装せずに手順をレンダリングできます。

Signal のセットアップ動作

• 公式の signal-cli GitHub リリースから、適切なリリースアセットをダウンロードします（ネイティブビルド、Linux x86-64 のみ）
• その他のプラットフォーム（macOS、非 x64 Linux）では、代わりに Homebrew を使用してインストールします
• リリースアセットによるインストールを ~/.openclaw/tools/signal-cli/<version>/ に保存します
• 設定に channels.signal.cliPath を書き込みます
• ネイティブ Windows はまだサポートされていません。Linux のインストールパスを利用するには、WSL2 内でオンボーディングを実行してください

関連ドキュメント

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