Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
openclaw onboard
ローカルまたはリモート Gateway セットアップのための完全なガイド付きオンボーディング。OpenClaw にモデル認証、ワークスペース、Gateway、チャネル、Skills、ヘルスを1つのフローで案内させたい場合に使用します。
関連ガイド
CLI オンボーディングハブ
インタラクティブな CLI フローのウォークスルー。
オンボーディング概要
OpenClaw のオンボーディング全体の構成。
CLI セットアップリファレンス
出力、内部構造、ステップごとの動作。
CLI 自動化
非インタラクティブフラグとスクリプト化されたセットアップ。
macOS アプリのオンボーディング
macOS メニューバーアプリのオンボーディングフロー。
例
--flow import は Hermes などの Plugin が所有する移行プロバイダーを使用します。これは新規の OpenClaw セットアップに対してのみ実行されます。既存の設定、認証情報、セッション、またはワークスペースのメモリ/ID ファイルが存在する場合は、インポート前にリセットするか新規セットアップを選択してください。
--modern は Crestodian の対話型オンボーディングプレビューを開始します。
--modern なしの場合、openclaw onboard は従来のオンボーディングフローを維持します。
平文のプライベートネットワーク ws:// ターゲット（信頼済みネットワークのみ）では、オンボーディングプロセス環境で OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 を設定します。
このクライアント側トランスポートの緊急回避策に対応する openclaw.json 設定はありません。
非インタラクティブなカスタムプロバイダー:
--custom-api-key は非インタラクティブモードでは任意です。省略した場合、オンボーディングは CUSTOM_API_KEY を確認します。
OpenClaw は一般的なビジョンモデル ID を画像対応として自動的にマークします。不明なカスタムビジョン ID には --custom-image-input を渡し、テキスト専用メタデータを強制するには --custom-text-input を渡します。
LM Studio は非インタラクティブモードでプロバイダー固有のキーフラグにも対応しています。
--custom-base-url のデフォルトは http://127.0.0.1:11434 です。--custom-model-id は任意です。省略した場合、オンボーディングは Ollama の推奨デフォルトを使用します。kimi-k2.5:cloud などのクラウドモデル ID もここで使用できます。
プロバイダーキーを平文ではなく参照として保存します。
--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 管理の Gateway トークンは検証されますが、解決済みの平文としてスーパーバイザーサービス環境メタデータに永続化されません。--install-daemonとともに使用する場合、トークンモードにトークンが必要で、設定済みのトークン SecretRef が解決できない場合、オンボーディングは修復ガイダンス付きで閉じた状態で失敗します。--install-daemonとともに使用する場合、gateway.auth.tokenとgateway.auth.passwordの両方が設定され、gateway.auth.modeが未設定の場合、オンボーディングはモードが明示的に設定されるまでインストールをブロックします。- ローカルオンボーディングは設定に
gateway.mode="local"を書き込みます。後続の設定ファイルにgateway.modeがない場合は、有効なローカルモードのショートカットではなく、設定の破損または不完全な手動編集として扱ってください。 - ローカルオンボーディングは、選択したセットアップパスで必要な場合に、選択されたダウンロード可能な Plugin をインストールします。
- リモートオンボーディングはリモート Gateway の接続情報のみを書き込み、ローカルの Plugin パッケージはインストールしません。
--allow-unconfiguredは別個の Gateway ランタイム緊急回避策です。オンボーディングがgateway.modeを省略してよいという意味ではありません。
--skip-healthを渡さない限り、オンボーディングは到達可能なローカル Gateway を待ってから正常終了します。--install-daemonは管理対象 Gateway のインストールパスを先に開始します。指定しない場合は、たとえばopenclaw gateway runなどでローカル Gateway がすでに実行されている必要があります。- 自動化で設定/ワークスペース/ブートストラップの書き込みだけを行いたい場合は、
--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は最初に Scheduled Tasks を試し、タスク作成が拒否された場合はユーザーごとの Startup フォルダーのログイン項目にフォールバックします。
- プロンプトが表示されたら シークレット参照を使用 を選択します。
- 次に次のいずれかを選択します。
- 環境変数
- 設定済みシークレットプロバイダー（
fileまたはexec）
- オンボーディングは参照を保存する前に高速な事前検証を実行します。
- 検証に失敗した場合、オンボーディングはエラーを表示し、再試行できるようにします。
非インタラクティブ Z.AI エンドポイントの選択
--auth-choice zai-api-key はキーに最適な Z.AI エンドポイントを自動検出します（zai/glm-5.1 を使用する汎用 API を優先）。GLM Coding Plan エンドポイントを特に使用したい場合は、zai-coding-global または zai-coding-cn を選択してください。フローの注記
フロータイプ
フロータイプ
quickstart: 最小限のプロンプトで、Gateway トークンを自動生成します。manual: ポート、バインド、認証に関する完全なプロンプト（advancedのエイリアス）。import: 検出された移行プロバイダーを実行し、計画をプレビューしてから、確認後に適用します。
プロバイダーの事前フィルタリング
プロバイダーの事前フィルタリング
認証選択が優先プロバイダーを示す場合、オンボーディングはデフォルトモデルと許可リストのピッカーをそのプロバイダーに事前フィルタリングします。Volcengine と BytePlus では、これはコーディングプランのバリアント（
volcengine-plan/*、byteplus-plan/*）にも一致します。優先プロバイダーのフィルターで読み込み済みモデルがまだ見つからない場合、オンボーディングはピッカーを空にするのではなく、未フィルタリングのカタログにフォールバックします。Web 検索のフォローアップ
Web 検索のフォローアップ
一部の Web 検索プロバイダーでは、プロバイダー固有のフォローアッププロンプトが表示されます。
- Grok は、同じ
XAI_API_KEYとx_searchモデル選択を使用する任意のx_searchセットアップを提示できます。 - Kimi は、Moonshot API リージョン（
api.moonshot.aiとapi.moonshot.cn）とデフォルトの Kimi Web 検索モデルを確認できます。
その他の動作
その他の動作
- ローカルオンボーディングの DM スコープ動作: CLI セットアップリファレンス。
- 最速の初回チャット:
openclaw dashboard（Control UI、チャネルセットアップなし）。 - カスタムプロバイダー: 一覧にないホスト型プロバイダーを含め、任意の OpenAI または Anthropic 互換エンドポイントに接続します。自動検出には Unknown を使用します。
- Hermes の状態が検出されると、オンボーディングは移行フローを提示します。ドライラン計画、上書きモード、レポート、正確なマッピングには 移行 を使用します。
一般的なフォローアップコマンド
openclaw setup を使用してください。対象を絞った変更には後で openclaw configure を使用し、チャネルのみのセットアップには openclaw channels add を使用します。
--json は非インタラクティブモードを意味しません。スクリプトには --non-interactive を使用してください。