CLI リファレンス

opencodex CLI は ocx です。最初のコマンド名でディスパッチされ、setup/init、restore/eject、models/model などの文書化された別名が同じ操作に達します。不明なコマンドと無効なコマンド形状はエラーです。

トップレベルで使用するには、ocx help (または ocx --help / ocx -h) を実行します。ヘルプテーブルに登録されているコマンドに対して、ocx help <command>、ocx <command> --help、または ocx <command> -h を実行します。ヘルプおよびバージョン コマンドは読み取り専用です。これらのコマンドは、Codex または opencodex の状態を開始、停止、インストール、アンインストール、または書き換えません。

コマンドファミリー

• ライフサイクル — セットアップ、プロキシとサービスのライフサイクル、健全性、診断、 カタログの同期、ダッシュボード、および更新。
• プロバイダー、アカウント、モデル — プロバイダー構成、 認証、資格情報プール、クォータ、カスタム モデル、可視性、選択されたモデル、およびコンテキストの上限。
• エージェント、ルーティング、統合 — マルチエージェント コントロール、コンボ、 可観測性、アドミッション キー、クライアント統合、ランタイム設定、および検証済みの構成。

ヘッドレス動作

管理コマンドは、2 番目の構成パスを維持するのではなく、記録されたランタイム ポートと ID チェックを使用して、稼働中のプロキシの管理 API をラウンドトリップします。停止したプロキシまたは到達不能なプロキシは HTTP 503 として表され、ゼロ以外の CLI 終了が生成されます。オフライン構成操作として明示的に文書化されているコマンドは、代わりに、稼働中のプロキシを使用せずに設定ファイルを検証および編集できます。

リストまたはステータスは、明確なデフォルトです。構造化スナップショットには --json を使用し、ストリーミング リクエスト ログ フィードには ocx observe logs --follow --jsonl を使用します。テーマ、言語、ナビゲーション、その他の純粋に視覚的なブラウザーの状態には、同等の CLI がありません。 Cloudflare Tunnel のセットアップはこのコマンド セットの外にあります。

終了コードと確認

成功したコマンドは 0 で終了します。無効な使用法、不明なコマンドまたはリソース、失敗した API 操作、および利用できない必要なサービスは 0 以外で終了します。 ocx health は、特にプロキシが正常な場合にのみ 0 で終了し、それ以外の場合は 1 で終了するため、サービス プローブとして使用できます。スクリプトは、人間が判読できる出力をスクレイピングするのではなく、終了コードをテストする必要があります。

確認を通知する破壊的な削除、インポート、クレジット消費、更新操作には、非対話型での --yes が必要です。このフラグは明示的なオプトインです。これを省略しても、黙ってアクションを確認してはなりません。

バージョンと内部ディスパッチターゲット

ocx --version、ocx -v、および ocx version は、スクリプト対応バージョンの 1 行を出力して終了します。

2 つのディスパッチ ターゲットは通常のヘルプから意図的に省略されています。__refresh-version [preview] は切り離されたプロセスで更新通知キャッシュを更新し、__gui-update-worker <job-id> [latest|preview] [restart] はダッシュボード更新ジョブを実行します。これらは実装の詳細であり、ユーザー向けの安定したコマンドではありません。ダッシュボードはワーカー PID を記録し、ワーカーが死亡したアクティブなジョブを回復し、PID のない古いアクティブ レコードを 10 分後に古いものとして扱い、ライブ ワーカーを同時更新から保護します。