Skip to content

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

Codex CLI 是来自OpenAI的本地编程智能体,可在您的计算机上运行。 如果您想在代码编辑器中使用 Codex(VS Code、Cursor、Windsurf),请在您的IDE中安装 如果您在寻找来自OpenAI的云端智能体——Codex Web,请访问 chatgpt.com/codex

Codex CLI splash


快速开始

安装和运行 Codex CLI

使用您喜欢的包管理器进行全局安装。如果您使用 npm:

shell
npm install -g @openai/codex

或者,如果您使用 Homebrew:

shell
brew install --cask codex

然后简单地运行 codex 开始使用:

shell
codex

如果您遇到 Homebrew 升级问题,请查看 FAQ 中关于 brew upgrade 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 CLI login

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

您也可以使用 Codex 与 API 密钥一起,但这需要额外的设置。如果您之前使用 API 密钥进行基于使用情况的计费,请查看迁移步骤。如果您在登录时遇到问题,请在此问题中评论。

模型上下文协议(MCP)

Codex 可以访问 MCP 服务器。要配置它们,请参考配置文档

配置

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

执行策略

请参见执行策略快速入门来设置管理 Codex 可以执行哪些命令的规则。

文档与常见问题


许可证

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