# openclaw onboard

ローカルまたはリモート Gateway セットアップのための対話型オンボーディング。

# 関連ガイド

# 例

openclaw onboard
openclaw onboard --modern
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --flow import
openclaw onboard --import-from hermes --import-source ~/.hermes
openclaw onboard --skip-bootstrap
openclaw onboard --mode remote --remote-url wss://gateway-host:18789

--flow import は Hermes などの Plugin 所有の移行プロバイダーを使用します。新規の OpenClaw セットアップに対してのみ実行されます。既存の設定、認証情報、セッション、またはワークスペースのメモリ/ID ファイルが存在する場合は、インポート前にリセットするか新規セットアップを選択してください。

--modern は Crestodian の会話型オンボーディングプレビューを開始します。--modern がない場合、openclaw onboard は従来のオンボーディングフローを維持します。

プレーンテキストのプライベートネットワーク ws:// ターゲット（信頼済みネットワークのみ）の場合は、オンボーディングプロセス環境で OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 を設定します。このクライアント側トランスポート用の緊急回避に対応する openclaw.json の設定はありません。

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

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-image-input

--custom-api-key は非対話型モードでは任意です。省略した場合、オンボーディングは CUSTOM_API_KEY を確認します。 OpenClaw は一般的なビジョンモデル ID を画像対応として自動的にマークします。不明なカスタムビジョン ID には --custom-image-input を渡し、テキストのみのメタデータを強制するには --custom-text-input を渡します。

LM Studio は非対話型モードでプロバイダー固有のキーフラグもサポートします。

openclaw onboard --non-interactive \
  --auth-choice lmstudio \
  --custom-base-url "http://localhost:1234/v1" \
  --custom-model-id "qwen/qwen3.5-9b" \
  --lmstudio-api-key "$LM_API_TOKEN" \
  --accept-risk

非対話型 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 トークンオプション:

• --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 管理の Gateway トークンは検証されますが、解決済みプレーンテキストとして supervisor サービス環境メタデータに永続化されません。
• --install-daemon では、トークンモードがトークンを必要とし、設定されたトークン SecretRef が未解決の場合、オンボーディングは修復ガイダンスとともに閉じた状態で失敗します。
• --install-daemon では、gateway.auth.token と gateway.auth.password の両方が設定され、gateway.auth.mode が未設定の場合、モードが明示的に設定されるまでオンボーディングはインストールをブロックします。
• ローカルオンボーディングは設定に gateway.mode="local" を書き込みます。後続の設定ファイルに gateway.mode がない場合、有効なローカルモードのショートカットではなく、設定の破損または不完全な手動編集として扱ってください。
• ローカルオンボーディングは、選択したセットアップパスで必要な場合、選択されたダウンロード可能な plugins をインストールします。
• リモートオンボーディングはリモート Gateway の接続情報のみを書き込み、ローカルの Plugin パッケージはインストールしません。
• --allow-unconfigured は別個の Gateway ランタイム用エスケープハッチです。これはオンボーディングが gateway.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

非対話型ローカル Gateway ヘルス:

• --skip-health を渡さない限り、オンボーディングは到達可能なローカル Gateway を待ってから正常終了します。
• --install-daemon はまず管理対象の Gateway インストールパスを開始します。指定しない場合、たとえば openclaw gateway run のように、ローカル Gateway がすでに実行中である必要があります。
• 自動化で設定/ワークスペース/bootstrap の書き込みだけを行いたい場合は、--skip-health を使用します。
• ワークスペースファイルを自分で管理する場合は、--skip-bootstrap を渡して agents.defaults.skipBootstrap: true を設定し、AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md、HEARTBEAT.md、BOOTSTRAP.md の作成をスキップします。
• ネイティブ Windows では、--install-daemon はまずタスクスケジューラを試し、タスク作成が拒否された場合はユーザーごとのスタートアップフォルダーのログイン項目にフォールバックします。

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

• プロンプトが表示されたら シークレット参照を使用 を選択します。
• 次に、次のいずれかを選択します。
  • 環境変数
  • 設定済みシークレットプロバイダー（file または exec）
• オンボーディングは参照を保存する前に高速な事前検証を実行します。
  • 検証に失敗した場合、オンボーディングはエラーを表示し、再試行できるようにします。

# 非対話型 Z.AI エンドポイントの選択肢

# Promptless endpoint selection
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# Other Z.AI endpoint choices:
# --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"

# フローメモ

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

openclaw configure
openclaw agents add <name>