Gateway CLI
Gateway は OpenClaw の WebSocket サーバーです(チャンネル、ノード、セッション、フック)。 このページのサブコマンドはopenclaw gateway … 配下にあります。
関連ドキュメント:
Gateway を実行する
ローカルの Gateway プロセスを実行します:- 既定では、
gateway.mode=localが~/.openclaw/openclaw.jsonに設定されていない限り、Gateway は起動を拒否します。アドホック/開発用途の実行には--allow-unconfiguredを使用してください。 ad-hoc/dev runs には--allow-unconfiguredを使用してください。 ad-hoc/dev runs には--allow-unconfiguredを使用してください。 - 認証なしで loopback を超えてバインドすることはブロックされます(安全ガードレール)。
SIGUSR1は、認可されている場合にインプロセスの再起動をトリガーします(commands.restartを有効にするか、gateway ツール/config の apply/update を使用してください)。SIGINT/SIGTERMハンドラーはゲートウェイプロセスを停止しますが、カスタムのターミナル状態は復元しません。TUI や raw モード入力で CLI をラップしている場合は、終了前にターミナルを復元してください。 CLI を TUI または raw-mode 入力でラップする場合は、ターミナルを終了する前に復元します。
オプション
--port <port>: WebSocket ポート(既定値は config/env から取得。通常は18789)。--bind <loopback|lan|tailnet|auto|custom>: リスナーのバインドモード。--auth <token|password>: 認証モードの上書き。--token <token>: トークンの上書き(プロセス用にOPENCLAW_GATEWAY_TOKENも設定します)。--password <password>: パスワードの上書き(プロセス用にOPENCLAW_GATEWAY_PASSWORDも設定します)。--tailscale <off|serve|funnel>: Tailscale 経由で Gateway を公開します。--tailscale-reset-on-exit: シャットダウン時に Tailscale の serve/funnel 設定をリセットします。--allow-unconfigured: config にgateway.mode=localがなくても Gateway の起動を許可します。--dev: 不足している場合に dev 設定 + ワークスペースを作成します(BOOTSTRAP.md をスキップ)。--reset: dev 設定 + 資格情報 + セッション + ワークスペースをリセットします(--devが必要)。--force: 起動前に選択したポートで既存のリスナーを終了します。--verbose: 詳細ログ。--claude-cli-logs: コンソールには claude-cli のログのみを表示します(stdout/stderr を有効化)。--ws-log <auto|full|compact>: websocket ログのスタイル(既定はauto)。--compact:--ws-log compactのエイリアス。--raw-stream: 生のモデルストリームイベントを jsonl に記録します。--raw-stream-path <path>: 生ストリーム jsonl のパス。
実行中の Gateway をクエリする
すべてのクエリコマンドは WebSocket RPC を使用します。 出力モード:- 既定: 人間可読(TTY では色付き)。
--json: 機械可読 JSON(スタイリング/スピナーなし)。--no-color(またはNO_COLOR=1): 人間向けレイアウトを維持したまま ANSI を無効化。
--url <url>: Gateway の WebSocket URL。--token <token>: Gateway トークン。--password <password>: Gateway パスワード。--timeout <ms>: タイムアウト/バジェット(コマンドごとに異なります)。--expect-final: 「final」レスポンスを待機します(エージェント呼び出し)。
--url を設定すると、CLI は config や環境の資格情報へフォールバックしません。
--token または --password を明示的に渡してください。明示的な資格情報が欠落している場合はエラーになります。
--token または --password を明示的に渡します。 明示的な資格情報が見つかりませんでした。
gateway health
gateway status
gateway status は、Gateway サービス(launchd/systemd/schtasks)と、オプションの RPC プローブを表示します。
--url <url>: プローブ URL を上書きします。--token <token>: プローブ用のトークン認証。--password <password>: プローブ用のパスワード認証。--timeout <ms>: プローブのタイムアウト(既定は10000)。--no-probe: RPC プローブをスキップします(サービスのみ表示)。--deep: システムレベルのサービスもスキャンします。
gateway probe
gateway probe は「すべてをデバッグ」するコマンドです。常に次をプローブします: それは常にプローブ: それは常にプローブ:
- 設定されているリモートゲートウェイ(設定されている場合)、および
- localhost(loopback)。リモートが設定されていても実行されます。
SSH 経由のリモート接続(Mac アプリとの同等性)
macOS アプリの「Remote over SSH」モードはローカルのポートフォワードを使用し、loopback のみにバインドされている可能性があるリモートゲートウェイをws://127.0.0.1:<port> で到達可能にします。
CLI の同等機能:
--ssh <target>:user@hostまたはuser@host:port(ポートの既定は22)。--ssh-identity <path>: identity ファイル。--ssh-auto: 検出された最初の Gateway ホストを SSH の接続先として選択します(LAN/WAB のみ)。
gateway.remote.sshTargetgateway.remote.sshIdentity
gateway call <method>
低レベルの RPC ヘルパーです。
Gateway サービスを管理する
gateway installは--port、--runtime、--token、--force、--jsonをサポートします。- ライフサイクルコマンドは、スクリプト向けに
--jsonを受け付けます。
ゲートウェイを検出する(Bonjour)
gateway discover は Gateway のビーコン(_openclaw-gw._tcp)をスキャンします。
- マルチキャスト DNS-SD:
local. - ユニキャスト DNS-SD(Wide-Area Bonjour): ドメインを選択(例:
openclaw.internal.)し、スプリット DNS + DNS サーバーを設定してください。/gateway/bonjour を参照してください。
role(ゲートウェイの役割ヒント)transport(トランスポートのヒント。例:gateway)gatewayPort(WebSocket ポート。通常は18789)sshPort(SSH ポート。未指定の場合の既定は22)tailnetDns(利用可能な場合の MagicDNS ホスト名)gatewayTls/gatewayTlsSha256(TLS 有効化 + 証明書フィンガープリント)cliPath(リモートインストール向けの任意ヒント)
gateway discover
--timeout <ms>: コマンドごとのタイムアウト(browse/resolve)。既定は2000。--json: 機械可読な出力(スタイリング/スピナーも無効化)。