エージェントのクイックスタート
このページは、端末から作業する AI エージェントやスクリプト利用者向けです。コマンド、終了ステータス、自動化できる操作とユーザーの同意が必要な操作の境界に焦点を当てています。人間が操作しながら進める場合は、クイックスタート を参照してください。対話形式で設定する場合は、Web ダッシュボードも利用できます。
opencodex のセットアップ
Section titled “opencodex のセットアップ”公開されたパッケージをインストールし、ocx が PATH 上にあることを確認します。
npm install -g @bitkyc08/opencodexocx --versionプロキシを実行する方法を 1 つ選択します。
# Foreground: blocks this terminal until stopped.ocx start
# Background: installs or updates the service, then starts it.ocx service対話型端末で ocx init を実行します。 ocx start がフォアグラウンドを占有している場合は、2 番目の端末を使用します。
ocx initウィザードは $OPENCODEX_HOME/config.json (通常は ~/.opencodex/config.json) を書き込みます。プロキシアドレスを Codex の config.toml に挿入し、任意で Codex の自動起動 shim をインストールすることもできます。ocx init 自体はプロキシを起動しません。完全に非対話型でセットアップする場合は、ウィザードを操作せず、以下のように ocx provider add でプロバイダーを設定します。
ヘッドレスインストールを確認する
Section titled “ヘッドレスインストールを確認する”スクリプトおよびエージェントの実行では、次の読み取り専用チェックを使用します。
ocx statusocx doctorocx health --jsonocx status はプロキシとサービスの状態を報告します。ocx doctor は、ローカル環境、ネットワーク、Codex ランタイム、アカウントの健全性に関する問題を診断します。ocx health はプロキシが正常なら終了コード 0、それ以外なら 1 を返します。--json を付けると構造化された出力を返します。
ocx combo set など、管理 API を利用するコマンドは稼働中のプロキシに接続します。プロキシが見つからない場合や API に到達できない場合、CLI は 503 エラーとして扱い、非ゼロで終了します。再試行する前に、フォアグラウンドのプロキシまたはバックグラウンドサービスを起動してください。コマンドとエンドポイントの全体像は、CLI リファレンス と 管理 API を参照してください。
ダッシュボードを使用せずにプロバイダーとコンボを追加する
Section titled “ダッシュボードを使用せずにプロバイダーとコンボを追加する”レジストリ プロバイダーは名前で追加できます。たとえば、これは Anthropic API キー プリセットを追加し、それをデフォルトのプロバイダーにします。
ocx provider add anthropic-apikey \ --api-key "$ANTHROPIC_API_KEY" \ --set-defaultocx provider add はローカル設定を書き込みます。稼働中のプロキシがすでに実行中で、モデルを Codex にすぐに同期したい場合は、--sync を追加します。それ以外の場合は、後で ocx sync を実行します。レジストリにないカスタム プロバイダーには、--adapter と --base-url の両方が必要です。
すべてのターゲット プロバイダーが構成され、プロキシが実行されたら、フェイルオーバー コンボを作成します。
ocx combo set main \ --targets anthropic/claude-opus-4-8,openai/gpt-5.6-sol \ --strategy failoverターゲットは provider/model 構文を使用し、カンマで区切られます。結果として得られる仮想モデルは combo/main です。戦略、重み、スティッキー ルーティング、および障害動作については、コンボ を参照してください。
リモートとLANのバインド
Section titled “リモートとLANのバインド”デフォルトのループバック バインドには API トークンは必要ありません。 0.0.0.0 などの非ループバック バインドには OPENCODEX_API_AUTH_TOKEN が必要です。プロキシはそれなしでは起動を拒否します。変数を ocx start の前、または ocx service install の前に設定して、サービスがそれを受け取るようにします。
export OPENCODEX_API_AUTH_TOKEN="your-secret-token"ocx service installその後、クライアントは管理リクエストとモデルリクエストを認証する必要があります。 opencodex をローカル マシンの外に公開する前に、構成 のリモート アクセス ルールを読んでください。