项目简介

'codex-acp' 是 Zed Industries 开发的一个工具，它充当一个 Agent 客户端协议（ACP）适配器，允许像 Zed 这样的 ACP 兼容客户端与 Codex 命令行工具进行交互。它将 ACP 协议请求（例如，发送提示、调用工具、管理会话）转换为 Codex CLI 可以理解的操作，并将 Codex 的响应以 ACP 格式返回给客户端。这使得 LLM 应用程序能够以标准化的方式利用 Codex 的能力。

主要功能点

上下文管理: 支持通过 '@' 提及来提供上下文信息给 AI 助手。
图像支持: 能够处理和显示图像内容。
工具调用: 允许 LLM 客户端调用外部工具或功能，并支持权限请求。
编辑审查: 提供代码或内容修改的审查功能。
任务列表: 支持管理待办事项列表。
斜杠命令: 内置 '/review'、'/init'、'/compact'、'/logout' 等常用命令。
自定义提示: 支持用户定义可定制的 LLM 交互模式。
Auth方法: 支持通过 ChatGPT 订阅、'CODEX_API_KEY' 或 'OPENAI_API_KEY' 进行认证。
会话管理: 创建、加载和管理与 LLM 的交互会话。

安装步骤

'codex-acp' 是一个命令行工具，可以通过以下两种方式安装：

下载预编译版本: 访问项目的 GitHub 发布页面，下载适用于您操作系统和架构的最新 'codex-acp' 可执行文件。下载后，将其放置在系统 PATH 中，以便可以直接从命令行运行。

通过 npm 安装: 如果您安装了 Node.js 和 npm，可以使用 'npx' 直接运行，或者安装到您的项目中：

npx @zed-industries/codex-acp

或者全局安装：

npm install -g @zed-industries/codex-acp

服务器配置（供 MCP 客户端使用）

MCP 客户端需要配置 'codex-acp' 服务器的启动命令。以下是典型的配置示例：

{
  "servers": {
    "codex": {
      "command": "codex-acp",
      "args": [],
      "env": {
        "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"
      }
    }
  }
}

参数注释:

'"codex"': 服务器的名称，可以自定义，用于在 MCP 客户端中标识此服务器。
'"command": "codex-acp"': 启动 'codex-acp' 可执行文件的命令。如果您通过 'npx' 运行，命令可能是 'npx'，并且 '@zed-industries/codex-acp' 将作为 'args' 的一部分。如果您已将下载的可执行文件添加到系统 PATH，则可以直接使用 'codex-acp'。
'"args": []': 传递给 'codex-acp' 命令的额外命令行参数。通常情况下，此项可以为空数组。
'"env": {}': 环境变量，用于配置 'codex-acp' 的认证信息。例如，'OPENAI_API_KEY' 或 'CODEX_API_KEY'，请替换 '"YOUR_OPENAI_API_KEY"' 为您的实际 API 密钥。

基本使用方法

一旦 'codex-acp' 服务器在您的 MCP 客户端中配置并启动，您就可以像使用任何其他 LLM Agent 一样与其交互：

启动一个新的会话: 在您的客户端中选择启动一个新的 Codex 会话。
发送提示: 直接向 AI 助手输入您的请求或问题。例如："请帮我审查一下最新的代码改动。"
使用斜杠命令: 您可以使用 '/review'、'/init' 等斜杠命令来触发特定功能。例如：'/review-branch main' 会指示 AI 助手审查当前分支与 'main' 分支的差异。
提供上下文: 在提示中使用 '@' 提及来引用文件或其他资源，AI 助手将能够访问这些上下文信息。

关键词

项目简介

主要功能点

安装步骤

服务器配置（供 MCP 客户端使用）

基本使用方法

信息