Codex CLI 的 ACP 适配器
codex-acp 是一个Stdio ACP代理服务器。 它启动Codex App Server,将ACP请求翻译为Codex操作,并将Codex事件映射回客户端.
特征
- ChatGPT,API密钥,以及客户端提供的自定义网关认证.
- 模型,推理努力,快模式,批准,和沙盒模式配置.
- 通过选入方式推荐的具体模型和推理效果值 AIR 建议的配置值 能力.
- 文本提示,嵌入上下文,图像,资源链接,以及额外的工作空间目录.
- 贝壳命令,文件更改, 权限请求, MCP 工具呼叫,终端输出,推理,计划,网页搜索,图像生成,图像视图,符号使用,以及审查事件.
- 通过谈判达成的压缩文件更改 AIR diff 补丁扩展。 。 。 .
- 对于AIR,一个工具调用形状,每个事实在一个领域作为 工具调用合同 定义。 其他客户保留先前的字段.
- 非加太原生子代理会议 (在能力谈判之后),有单独的儿童历史和根序权限;否则,遗留的工具召唤会倒退.
- 中转输入通过 会话/扩展名( s),在无法接受的情况下,有一个选择进入宿主的倒计时.
- Async 代码问题 因为没有阻塞的表格 被引导到要求答案的转弯.
- 背景终端任务 具有任务地位,并在能力谈判后有针对性地停止支助.
- AIR的会话范围长期目标 目标扩展。 。 。 .
- 通过选入键输入警告和出错 AIR 会话失败扩展。 。 。 .
- 所有航空延伸、能力以及
_meta键 : 空中扩展。 。 。 . - 每回转一回 代理文件更改报告 在能力谈判之后.
- 客户端提供,会话范围d 系统提示附件,保留已配置的开发者指令.
- 客户端提供的MCP服务器通过基于命令的stdio配置和HTTP传输.
- 斜线命令 :
/status, (中文(简体) ),/mcp(与/mcp reconnect, (中文(简体) ),/skills, (中文(简体) ),/goal, (中文(简体) ),/review, (中文(简体) ),/review-branch, (中文(简体) ),/review-commit, (中文(简体) ),/compact,以及/logout,以及配置的技能.
安装
直接运行已发布软件包 :
npx -y @agentclientprotocol/codex-acp
或在全球安装:
npm install -g @agentclientprotocol/codex-acp
codex-acp --version
Npm 软件包包含兼容 @openai/codex 依赖性。 设定 CODEX_PATH 仅在您希望适配器运行不同的 Codex 二进制时 :
CODEX_PATH=/path/to/codex npx -y @agentclientprotocol/codex-acp
尝试已登陆的更改 main ,但尚未发布,从
preview 频道. 推进到 main 触发预览发布而不等待
释放被排除在外,新的推力可以
替换已队列预览 。 见
文件/参考文件。 。 。 .
npx -y @agentclientprotocol/codex-acp@preview
认证
适配器在初始化过程中广告ACP认证方法. 客户端可以使用:
- ChatGPT 登录 。 设定
NO_BROWSER=1在远程或无浏览器环境中隐藏此方法. - API 密钥通过
CODEX_API_KEY或者说OPENAI_API_KEY。 。 。 . - 一个自定义的OpenAI兼容网关,当客户端选择进入网关认证能力时.
运行时间选项
CODEX_API_KEY- 在选择 API- key 认证方法时使用的 API 密钥 。 胜过OPENAI_API_KEY。 。 。 .OPENAI_API_KEY- 在选择 API- key 认证方法时使用的倒置 API 密钥 .CODEX_PATH- 运行一个特定的可执行代码,而不是捆绑的软件包依赖.CODEX_CONFIG- JSON 对象合并为 Codex 会话配置 .MODEL_PROVIDER- 模式提供商通过代码x进行新会话.DEFAULT_AUTH_REQUEST- ACP 认证请求 JSON 当 Codex 需要认证时使用.INITIAL_AGENT_MODE- 初始模式编号 :read-only, (中文(简体) ),workspace-write, (中文(简体) ),agent,或agent-full-access。 。 。 .NO_BROWSER- 设定时隐藏基于浏览器的 ChatGPT 认证 .APP_SERVER_LOGS- 适配器日志目录.
发展
npm install
npm run start
npm run typecheck
npm test
在其中建立独立的二进制 dist/bin 改为:
npm run bundle:all
见 读取器- dev.md 用于本地客户端配置、二进制包装和 Codex 类型再生.
副代理人会议
分机构会议在草案之后举行 ACP 副代理人RFD 并且只有在谈判期间经过双边能力谈判后才能使用 initialize. 没有本土谈判,子代理人的生命周期仍是一个普通的非加太工具呼叫.
见 医生/助产人员会议 谈判 生命周期事件, session/load 重建,以及遗留下来的细节.
背景终端任务
代码可以让一个 shell 命令在转弯继续后运行. AIR客户端可以在Async Tasks面板上显示这项工作并停止一个命令.
见 空中扩展 能力 生命周期事件 停止请求.
许可证
通过贡献,你同意 您的捐款将获得 Apache 2.0 许可证.