agentclientprotocol/codex-acp
ACP server implementation that exposes Codex CLI functionality for smoother client and IDE integration.
ACP adapter for Codex CLI
What it is – @agentclientprotocol/codex-acp は、Agent Client Protocol (ACP) クライアントが OpenAI Codex と通信できるようにする Node-JS サーバーです。Codex をサブプロセスとして実行し、標準の ACP リクエスト/レスポンス形式を Codex API 呼び出しに変換して、Codex イベントをクライアントに転送します。
Why it matters – ACP は、コードの実行、ファイルの編集、Web ブラウジングなどを行う AI 駆動の「エージェント」を構築するためのプロトコルです。このアダプターは、Codex(GitHub Copilot の背後にあるコード生成モデル)をそのエコシステムに接続するため、開発者は他のエージェント(ChatGPT、Claude など)で使用するのと同じ統一インターフェースを通じて Codex を使用できます。
Key capabilities
| Feature | What it does |
|---|---|
| Authentication | ChatGPT スタイルのログイン、API キー認証 (CODEX_API_KEY / OPENAI_API_KEY)、およびカスタムの OpenAI 互換ゲートウェイをサポートします。 |
| Configurable session | 環境変数または CODEX_CONFIG を介して、モデル、推論の努力、高速モード、サンドボックスモード、およびその他の Codex 設定を選択できます。 |
| Rich I/O | テキストプロンプト、埋め込みコンテキスト、画像、リソースリンク、および追加のワークスペースディレクトリを処理します。 |
| Tool-call events | シェルコマンド、ファイル変更、権限リクエスト、MCP ツール呼び出し、Web 検索、画像生成、トークン使用量などのイベントを発行します。 |
| AIR extensions | Agent Interaction Runtime (AIR) 拡張を実装します:diff-patch、非同期バックグラウンドタスク、目標追跡、型付き警告/エラー、ターンごとのファイル変更レポートなど。 |
| Sub-agent sessions | 能力交渉の後、個別の履歴と権限ルーティングを持つネイティブなサブエージェントセッションを作成します。 |
| Slash commands | インタラクティブな制御のための組み込みコマンド (/status, /mcp, /goal, /review, /compact, /logout, …) を備えています。 |
| MCP integration | stdio または HTTP を介したクライアント提供の MCP サーバーを許可します。 |
| Packaging | npm 経由で配布され、npx で実行するか、グローバルにインストールできます。 |
Quick start (npm)
# Run the latest released version without installing
npx -y @agentclientprotocol/codex-acp
# Or install globally
npm install -g @agentclientprotocol/codex-acp
codex-acp --version
Optional: point the adapter at a different Codex binary:
CODEX_PATH=/my/codex npx -y @agentclientprotocol/codex-acp
For the bleeding-edge preview builds:
npx -y @agentclientprotocol/codex-acp@preview
Runtime configuration (environment variables)
| Variable | Purpose |
|---|---|
CODEX_API_KEY / OPENAI_API_KEY |
Codex 認証用の API キー(前者が優先されます)。 |
CODEX_PATH |
カスタム Codex 実行可能ファイルへのパス。 |
CODEX_CONFIG |
Codex セッション設定にマージされる JSON 文字列。 |
MODEL_PROVIDER |
新しいセッションで Codex が使用するモデルプロバイダーを選択します。 |
INITIAL_AGENT_MODE |
初期権限モード (read-only, workspace-write, agent, agent-full-access) を設定します。 |
NO_BROWSER |
ブラウザベースの ChatGPT ログインフローを抑制します。 |
APP_SERVER_LOGS |
アダプターがログを書き込むディレクトリ。 |
Development workflow
npm install # install deps
npm run start # launch the adapter locally
npm run typecheck # TypeScript check
npm test # run test suite
npm run bundle:all # produce self-contained binaries in dist/bin
See readme-dev.md for details on local client configuration, binary packaging, and Codex type regeneration.
Extensibility & protocol details
- AIR extensions – このアダプターは
docs/air-extensions.mdに文書化されている AIR 拡張の全セット(diff-patch、非同期タスク、目標追跡、セッション失敗など)を実装しています。これらの機能を交渉するクライアントは、よりリッチで構造化されたイベントを受け取ります。 - Sub-agent sessions – ドラフト ACP サブエージェント RFD に従います。二国間交渉の後、子セッションは独自の履歴と権限ルーティングを取得し、クライアントがサポートしていない場合は通常のツール呼び出しにフォールバックします。
- Background terminal tasks – Codex はターン終了後もシェルコマンドを実行し続けることができます。アダプターは、AIR 対応クライアントに対してタスクのステータスと停止リクエストを表示します。
License
Contributions are licensed under the Apache 2.0 license.
Bottom line – codex-acp は、ACP 互換の AI エージェントが OpenAI Codex を使用できるようにする本番環境対応のブリッジであり、最新の AIR 拡張、サブエージェントセッション、およびインタラクティブなツールを完全にサポートしています。
関連
- プロジェクト
- Dispatch
- プロジェクト
- プロジェクト
- プロジェクト