`openclaw onboard`

対話式オンボーディングウィザード（ローカルまたはリモートGatewayセットアップ）です。

使用例

openclaw onboard
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --mode remote --remote-url wss://gateway-host:18789

プレーンテキストのプライベートネットワーク ws:// ターゲット（信頼済みネットワーク限定）の場合は、オンボーディングプロセス環境で OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 を設定してください。

非対話式カスタムプロバイダ:

openclaw onboard --non-interactive \
  --auth-choice custom-api-key \
  --custom-base-url "https://llm.example.com/v1" \
  --custom-model-id "foo-large" \
  --custom-api-key "$CUSTOM_API_KEY" \
  --secret-input-mode plaintext \
  --custom-compatibility openai

--custom-api-key は非対話式モードでは任意です。省略した場合、オンボーディングは CUSTOM_API_KEY をチェックします。

非対話式Ollama:

openclaw onboard --non-interactive \
  --auth-choice ollama \
  --custom-base-url "http://ollama-host:11434" \
  --custom-model-id "qwen3.5:27b" \
  --accept-risk

--custom-base-url のデフォルトは http://127.0.0.1:11434 です。--custom-model-id は任意で、省略するとOllamaの推奨デフォルトが使用されます。kimi-k2.5:cloud のようなクラウドモデルIDも使用可能です。

プロバイダキーをプレーンテキストではなく参照として保存:

openclaw onboard --non-interactive \
  --auth-choice openai-api-key \
  --secret-input-mode ref \
  --accept-risk

--secret-input-mode ref を使用すると、オンボーディングはプレーンテキストのキー値ではなく環境変数ベースの参照を書き込みます。認証プロファイルベースのプロバイダの場合は keyRef エントリが書き込まれます。カスタムプロバイダの場合は models.providers.<id>.apiKey が環境変数参照として書き込まれます（例: { source: "env", provider: "default", id: "CUSTOM_API_KEY" }）。

非対話式 ref モードの規約:

オンボーディングプロセス環境でプロバイダ環境変数を設定してください（例: OPENAI_API_KEY）。
その環境変数も設定されていない限り、インラインキーフラグ（例: --openai-api-key）は渡さないでください。
必要な環境変数なしでインラインキーフラグを渡した場合、ガイダンス付きで即座に失敗します。

非対話式モードでのゲートウェイトークンオプション:

--gateway-auth token --gateway-token <token> でプレーンテキストトークンを保存。
--gateway-auth token --gateway-token-ref-env <name> で gateway.auth.token を環境変数SecretRefとして保存。
--gateway-token と --gateway-token-ref-env は排他的です。
--gateway-token-ref-env はオンボーディングプロセス環境に空でない環境変数が必要です。
--install-daemon を使用する場合、トークン認証がトークンを必要とする際、SecretRef管理のゲートウェイトークンはバリデーションされますが、スーパーバイザーサービス環境メタデータに解決済みプレーンテキストとして永続化されません。
--install-daemon を使用する場合、トークンモードがトークンを必要とし、設定済みトークンSecretRefが未解決の場合、改善ガイダンス付きでクローズドに失敗します。
--install-daemon を使用する場合、gateway.auth.token と gateway.auth.password の両方が設定されており gateway.auth.mode が未設定の場合、modeを明示的に設定するまでインストールがブロックされます。

例:

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 \
  --accept-risk

非対話式ローカルゲートウェイヘルスチェック:

--skip-health を渡さない限り、正常終了前にローカルゲートウェイへの到達性を待機します。
--install-daemon はマネージドゲートウェイのインストールパスを先に開始します。これがない場合は、openclaw gateway run などでローカルゲートウェイが既に実行されている必要があります。
自動化でconfig/workspace/bootstrapの書き込みだけが必要な場合は --skip-health を使用してください。
ネイティブWindowsでは、--install-daemon はまずスケジュールされたタスクを試み、タスク作成が拒否された場合はユーザーごとのスタートアップフォルダーのログイン項目にフォールバックします。

対話式オンボーディングでの参照モード:

プロンプトでシークレット参照を使用を選択します。
その後、以下のいずれかを選択します:
- 環境変数
- 設定済みシークレットプロバイダ（file または exec）
オンボーディングは参照を保存する前に高速なプリフライトバリデーションを実行します。
- バリデーションが失敗した場合、エラーが表示されリトライが可能です。

非対話式Z.AIエンドポイントの選択:

注意: --auth-choice zai-api-key はキーに最適なZ.AIエンドポイントを自動検出するようになりました（zai/glm-5 を使用する汎用APIが優先されます）。 GLM Coding Planエンドポイントを明示的に使用したい場合は、zai-coding-global または zai-coding-cn を選択してください。

# プロンプトなしのエンドポイント選択
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# その他のZ.AIエンドポイント:
# --auth-choice zai-coding-cn
# --auth-choice zai-global
# --auth-choice zai-cn

非対話式Mistralの例:

openclaw onboard --non-interactive \
  --auth-choice mistral-api-key \
  --mistral-api-key "$MISTRAL_API_KEY"

フローに関する注意:

quickstart: 最小限のプロンプトで、ゲートウェイトークンを自動生成します。
manual: ポート/バインド/認証のフルプロンプト（advanced のエイリアス）。
ローカルオンボーディングのDMスコープ動作: CLI Onboarding Reference。
最速の初回チャット: openclaw dashboard（Control UI、チャンネル設定不要）。
カスタムプロバイダ: 一覧にないプロバイダを含め、OpenAIまたはAnthropic互換の任意のエンドポイントに接続可能。Unknownで自動検出も可能。

よく使うフォローアップコマンド

openclaw configure
openclaw agents add <name>

注意: --json は非対話式モードを意味しません。スクリプトには --non-interactive を使用してください。

openclaw onboard

関連ガイド

使用例

よく使うフォローアップコマンド

`openclaw onboard`