# @alas-ide/codex-acp 中文文档 规范地址：https://npmcn.com/package/%40alas-ide/codex-acp/ 版本：2\.5\.0-alas\.9 npm 元数据更新时间：2026-11-08T09:17:16.087Z 中文译文更新时间：2026-11-08T07:10:14.588Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40alas-ide/codex-acp 原文对照：https://npmcn.com/package/%40alas-ide/codex-acp/?lang=original 项目主页：https://github.com/mrmans0n/codex-acp#readme 源码仓库：https://github.com/mrmans0n/codex-acp ## 关键信息（来自 npm 元数据） - 包体积（解压后）：2.2 MB，4 个文件 - 模块格式：ES Module - TypeScript 类型：未声明 - 运行依赖：7 个 - 首次发布：2026-10-05T01:32:33.611Z - 最新版本发布：2026-11-08T09:17:15.757Z - 近 30 天下载量：1878（2026-10-06 至 2026-11-04，npm 官方下载统计） - 已发布版本数：17（近 12 个月 17 个） ## 中文简介 [![npm version](https://img.shields.io/npm/v/%40agentclientprotocol%2Fcodex-acp)](https://www.npmjs.com/package/@agentclientprotocol/codex-acp) ## 安装 ```sh npm install @alas-ide/codex-acp ``` 也可以使用：`pnpm add @alas-ide/codex-acp`、`yarn add @alas-ide/codex-acp`、`bun add @alas-ide/codex-acp` ## README # Codex CLI 的 ACP 适配器 [![npm version](https://img.shields.io/npm/v/%40agentclientprotocol%2Fcodex-acp)](https://www.npmjs.com/package/@agentclientprotocol/codex-acp) 使用 [OpenAI 代码](https://github.com/openai/codex) 从 [代理客户协议](https://agentclientprotocol.com/) 客户. `codex-acp` 是一个Stdio ACP代理服务器。 它启动Codex App Server,将ACP请求翻译为Codex操作,并将Codex事件映射回客户端. ## 特征 - ChatGPT,API密钥,以及客户端提供的自定义网关认证. - 模型,推理努力,快模式,批准,和沙盒模式配置. - 通过选入方式推荐的具体模型和推理效果值 [AIR 建议的配置值](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#recommended-config-values) 能力. - 文本提示,嵌入上下文,图像,资源链接,以及额外的工作空间目录. - 贝壳命令,文件更改, [权限请求](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#permission-presentation), MCP 工具呼叫,终端输出,推理,计划,网页搜索,图像生成,图像视图,符号使用,以及审查事件. - 通过谈判达成的压缩文件更改 [AIR diff 补丁扩展](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#diff-patch)。 。 。 . - 对于AIR,一个工具调用形状,每个事实在一个领域作为 [工具调用合同](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#tool-call-contract) 定义。 其他客户保留先前的字段. - [非加太原生子代理会议](https://npmcn.com/package/%40alas-ide/codex-acp/docs/subagent-sessions.md) (在能力谈判之后),有单独的儿童历史和根序权限;否则,遗留的工具召唤会倒退. - 中转输入通过 [会话/扩展名( s)](https://npmcn.com/package/%40alas-ide/codex-acp/docs/steering.md),在无法接受的情况下,有一个选择进入宿主的倒计时. - [Async 代码问题](https://npmcn.com/package/%40alas-ide/codex-acp/docs/async-questions.md) 因为没有阻塞的表格 被引导到要求答案的转弯. - [背景终端任务](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#async-tasks) 具有任务地位,并在能力谈判后有针对性地停止支助. - AIR的会话范围长期目标 [目标扩展](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#goal)。 。 。 . - 通过选入键输入警告和出错 [AIR 会话失败扩展](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#session-failure)。 。 。 . - 所有航空延伸、能力以及 `_meta` 键 : [空中扩展](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md)。 。 。 . - 每回转一回 [代理文件更改报告](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#agent-file-change-report) 在能力谈判之后. - 客户端提供,会话范围d [系统提示附件](https://npmcn.com/package/%40alas-ide/codex-acp/docs/system-prompt-extension.md),保留已配置的开发者指令. - 客户端提供的MCP服务器通过基于命令的stdio配置和HTTP传输. - 斜线命令 : `/status`, (中文(简体) ), `/mcp` (与 `/mcp reconnect`, (中文(简体) ), `/skills`, (中文(简体) ), `/goal`, (中文(简体) ), `/review`, (中文(简体) ), `/review-branch`, (中文(简体) ), `/review-commit`, (中文(简体) ), `/compact`,以及 `/logout`,以及配置的技能. ## 安装 直接运行已发布软件包 : ```bash npx -y @agentclientprotocol/codex-acp ``` 或在全球安装: ```bash npm install -g @agentclientprotocol/codex-acp codex-acp --version ``` Npm 软件包包含兼容 `@openai/codex` 依赖性。 设定 `CODEX_PATH` 仅在您希望适配器运行不同的 Codex 二进制时 : ```bash CODEX_PATH=/path/to/codex npx -y @agentclientprotocol/codex-acp ``` 尝试已登陆的更改 `main` ,但尚未发布,从 `preview` 频道. 推进到 `main` 触发预览发布而不等待 释放被排除在外,新的推力可以 替换已队列预览 。 见 [文件/参考文件](https://npmcn.com/package/%40alas-ide/codex-acp/docs/RELEASES.md#preview-releases)。 。 。 . ```bash 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` - 适配器日志目录. ## 发展 ```bash npm install npm run start npm run typecheck npm test ``` 在其中建立独立的二进制 `dist/bin` 改为: ```bash npm run bundle:all ``` 见 [读取器- dev.md](https://npmcn.com/package/%40alas-ide/codex-acp/readme-dev.md) 用于本地客户端配置、二进制包装和 Codex 类型再生. ### 副代理人会议 分机构会议在草案之后举行 [ACP 副代理人RFD](https://github.com/agentclientprotocol/agent-client-protocol/pull/1992) 并且只有在谈判期间经过双边能力谈判后才能使用 `initialize`. 没有本土谈判,子代理人的生命周期仍是一个普通的非加太工具呼叫. 见 [医生/助产人员会议](https://npmcn.com/package/%40alas-ide/codex-acp/docs/subagent-sessions.md) 谈判 生命周期事件, `session/load` 重建,以及遗留下来的细节. ### 背景终端任务 代码可以让一个 shell 命令在转弯继续后运行. AIR客户端可以在Async Tasks面板上显示这项工作并停止一个命令. 见 [空中扩展](https://npmcn.com/package/%40alas-ide/codex-acp/docs/air-extensions.md#async-tasks) 能力 生命周期事件 停止请求. ## 许可证 通过贡献,你同意 您的捐款将获得 Apache 2.0 许可证. ## 常见问题 ### 如何安装 @alas-ide/codex-acp？ 在项目目录运行 npm install @alas-ide/codex-acp，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 codex-acp，可以用 npx codex-acp 直接运行。 ### @alas-ide/codex-acp 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/alas-ide\_\_codex-acp 是否存在。 ### @alas-ide/codex-acp 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @alas-ide/codex-acp 可以商用吗？ @alas-ide/codex-acp 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @alas-ide/codex-acp 的下载量有多少？ 根据 npm 官方下载统计，@alas-ide/codex-acp 在 2026/10/06 – 2026/11/04 这 30 天内被下载 1,878 次，日均约 63 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @alas-ide/codex-acp 还在维护吗？ 最新版本 2\.5\.0-alas\.9 发布于 2026/11/08（今天）；至今共发布 17 个版本，其中过去 12 个月发布了 17 个；首次发布于 2026/10/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。