📘 codex
← 返回首页

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

Codex CLI 是 OpenAI 推出的一个编码代理，可在您的计算机上本地运行。

如果您希望在代码编辑器（如 VS Code、Cursor、Windsurf）中使用 Codex，请在您的 IDE 中安装
如果您正在寻找 OpenAI 的基于云的代理，即 Codex Web，请访问 chatgpt.com/codex

Codex CLI splash

快速开始

安装并运行 Codex CLI

使用您偏好的包管理器进行全局安装。如果您使用 npm：

npm install -g @openai/codex

或者，如果您使用 Homebrew：

brew install --cask codex

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

codex

如果您在使用 Homebrew 升级时遇到问题，请参阅 关于 brew upgrade codex 的 FAQ 条目。

您也可以前往 最新的 GitHub Release 页面，下载适用于您平台的相应二进制文件。 每个 GitHub Release 包含多个可执行文件，但实际上，您很可能需要以下之一： - 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`。

将 Codex 与您的 ChatGPT 套餐配合使用

Codex CLI login

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

您也可以使用 API 密钥来使用 Codex，但这需要额外的设置。如果您之前使用过基于使用量的计费 API 密钥，请参阅迁移步骤。如果在登录时遇到问题，请在此 issue 上留言。

模型上下文协议 (MCP)

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

配置

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

Execpolicy 快速开始

Codex 可以在运行 shell 命令之前强制执行您自己的基于规则的执行策略。

  1. 创建一个策略目录：mkdir -p ~/.codex/policy。
  2. 在该文件夹中创建一个或多个 .codexpolicy 文件。Codex 会在启动时自动加载其中的每个 .codexpolicy 文件。
  3. 编写 prefix_rule 条目来描述您想要允许、提示或阻止的命令：
prefix_rule(
    pattern = ["git", ["push", "fetch"]],
    decision = "prompt",  # allow | prompt | forbidden
    match = [["git", "push", "origin", "main"]],  # 必须匹配的示例
    not_match = [["git", "status"]],              # 必须不匹配的示例
)
  • pattern 是一个 shell 令牌列表，从左到右进行评估；将令牌包裹在嵌套列表中以表示替代选项（例如，同时匹配 push 和 fetch）。
  • decision 设置严重性；当多个规则匹配时，Codex 会选择最严格的决策（forbidden > prompt > allow）。
  • match 和 not_match 充当（可选的）单元测试。Codex 在加载策略时会验证它们，因此如果示例出现意外行为，您会得到反馈。

在此示例规则中，如果 Codex 想要运行前缀为 git push 或 git fetch 的命令，它将首先请求用户批准。

在保存规则之前，使用 codex execpolicy check 子命令来预览决策（有关语法详情，请参阅 codex-execpolicy README）：

codex execpolicy check --policy ~/.codex/policy/default.codexpolicy git push origin main

传递多个 --policy 标志来测试多个文件的组合效果，并使用 --pretty 获取格式化的 JSON 输出。有关可用语法的更详细演练，请参阅 codex-rs/execpolicy README。

注意：execpolicy 命令仍处于预览阶段。其 API 未来可能会有破坏性变更。

文档和常见问题解答

许可证

此代码库根据 Apache-2.0 许可证 授权。

原文地址 https://github.com/openai/codex/blob/main/README.md