OpenAI Codex CLI

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

Codex CLI is a coding agent from OpenAI that runs locally on your computer.

快速入门

安装并运行 Codex CLI

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

npm install -g @openai/codex

或者，如果您使用 Homebrew：

brew install codex

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

codex

每个 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。

使用 Codex 和你的 ChatGPT 计划

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

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

模型上下文协议 (MCP)

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

配置

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

文档和常见问题解答

• 入门
• CLI 使用方法
• 使用提示符作为输入运行
• 提示符示例
• Memory with AGENTS.md
• 配置
• 沙盒和审批
• 身份验证
• 授权方法
• 在“无头”设备上登录
• 高级
• 非交互式 / CI 模式
• 跟踪 / 详细日志记录
• 模型上下文协议 (MCP)
• 零数据保留 (ZDR)
• 贡献
• 安装和构建
• 系统要求
• DotSlash
• 从源代码构建
• 常见问题
• 开源基金

许可证

此代码库遵循 Apache-2.0 许可证。