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 チャンネル）
• ウェブ検索プロバイダー（任意）
• デーモンのインストール（LaunchAgent、systemd ユーザーユニット、または Startup フォルダーへのフォールバックを備えたネイティブ 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" }）
  • 設定済みプロバイダー参照（file または exec）。プロバイダーのエイリアス + ID を使用
• 対話型の参照モードでは、保存前に高速な事前検証を実行します。
  • 環境変数参照: 現在のオンボーディング環境で、変数名と値が空でないことを検証します。
  • プロバイダー参照: プロバイダー設定を検証し、要求された 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（オンボーディングでは明示的な値を保持し、それ以外の場合は未設定のままにします。そのため、main のデフォルトにより、すべてのチャネルのダイレクトメッセージがエージェントのローリングメインセッションに保持されます。これは個人用エージェントのデフォルトです。共有またはマルチユーザーの受信トレイでは per-channel-peer を使用してください。openclaw security audit は、マルチユーザーの DM トラフィックを検出すると分離を推奨します）
• 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.entries.* と、任意の bindings を書き込みます。

WhatsApp の認証情報は ~/.openclaw/credentials/whatsapp/<accountId>/ に保存されます。 アクティブなセッションとトランスクリプトは ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite に保存されます。 ~/.openclaw/agents/<agentId>/sessions/ ディレクトリは、レガシー移行の 入力およびアーカイブやサポート用の成果物に使用されます。

インストール済みアプリの推奨

モデルアクセスのチェックに成功すると、macOS の従来の対話型オンボーディングは、macOS のプライバシー権限を要求せずにアプリケーション名とバンドル ID をスキャンします。公式 Plugin カタログと ClawHub を検索し、設定済みモデルに、名前が誤って一致した候補を除外して関連する Plugin または Skills を推奨するよう求めます。推奨された一致候補はデフォルトで選択されます。任意の一致候補は明示的に選択する必要があります。

結果画面には検出されたアプリケーションが一覧表示され、「アプリ名は、設定済みモデルと ClawHub 検索を使用して照合されました。」と表示されます。wizard.appRecommendations を false に設定すると、このオンボーディング手順と、Gateway による Node アプリインベントリへのアクセスの両方が無効になります。このスキャンは、クイックスタートまたは macOS 以外のオンボーディングでは使用されません。

非対話型セットアップ

--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>/ に保存します
• 設定に kind: "managed-native" を含む channels.signal.transport.cliPath を書き込みます
• ネイティブ Windows はまだサポートされていません。Linux のインストールパスを使用するには WSL2 内でオンボーディングを実行してください

関連ドキュメント

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