npm i -g @openai/codex
或 brew install codex

Codex CLI 是来自 OpenAI 的编码代理，可在您的计算机上本地运行。

如果您需要帮助或支持使用 Codex，而不是报告错误，请在 [codex/discussions](https://github.com/migrant620/codexCN/discussions) 上发布，您可以在那里提问或与他人就如何改进 codex 的想法进行交流。
如果您正在寻找来自 OpenAI 的基于云的代理，Codex Web，请访问 chatgpt.com/codex

---

快速开始

安装和运行 Codex CLI

使用您首选的包管理器全局安装。如果您使用 npm：

npm install -g @openai/codex

或者，如果您使用 Homebrew：

brew install codex

然后只需运行 codex 即可开始：

codex

您也可以前往 最新 GitHub 发布版本 并下载适合您平台的二进制文件。

每个 GitHub 发布版本都包含许多可执行文件，但实际上，您可能需要以下其中之一：

• macOS
  • Apple Silicon/arm64: codex-aarch64-apple-darwin.tar.gz
  • x86_64（较旧的 Mac 硬件）: codex-x86_64-apple-darwin.tar.gz
• Linux
  • x86_64: codex-x86_64-unknown-linux-musl.tar.gz
  • arm64: codex-aarch64-unknown-linux-musl.tar.gz

每个压缩包都包含一个名称中包含平台信息的条目（例如，codex-x86_64-unknown-linux-musl），因此您可能需要在解压后将其重命名为 codex。

使用 ChatGPT 计划使用 Codex

运行 codex 并选择 使用 ChatGPT 登录。我们建议您登录到 ChatGPT 账户，以作为您的 Plus、Pro、Team、Edu 或 Enterprise 计划的一部分使用 Codex。了解您的 ChatGPT 计划中包含的内容。

您也可以使用 API Key 使用 Codex，但这需要额外设置。如果您之前使用 API Key 进行按使用量计费，请参阅迁移步骤。如果您在登录时遇到问题，请在此问题中评论。

模型上下文协议 (MCP)

Codex CLI 支持 MCP 服务器。通过在 ~/.codex/config.toml 中添加 mcp_servers 部分来启用。

配置

Codex CLI 支持丰富的配置选项，偏好设置存储在 ~/.codex/config.toml 中。有关完整的配置选项，请参阅配置。

---

文档和常见问题

• 快速开始
  • CLI 使用
  • 使用提示作为输入运行
  • 示例提示
  • 使用 AGENTS.md 的记忆功能
  • 配置
• 沙盒和批准
• 身份验证
  • 身份验证方法
  • 在"无头"机器上登录
• 高级功能
  • 非交互式 / CI 模式
  • 跟踪 / 详细日志
  • 模型上下文协议 (MCP)
• 零数据保留 (ZDR)
• 贡献
• 安装和构建
  • 系统要求
  • DotSlash
  • 从源代码构建
• 常见问题
• 开源基金

---

许可证

此仓库根据 Apache-2.0 许可证 获得许可。