npm i -g @openai/codex
或 brew install codex
Codex CLI 是来自 OpenAI 的编码代理，可在你的计算机上本地运行。 如果你想在代码编辑器（VS Code、Cursor、Windsurf）中使用 Codex，在你的 IDE 中安装 如果你正在寻找来自 OpenAI 的基于云的代理，Codex Web，请访问 chatgpt.com/codex
快速入门
安装和运行 Codex CLI
使用你首选的包管理器全局安装。如果你使用 npm：
npm install -g @openai/codex
或者，如果你使用 Homebrew：
brew install codex
然后只需运行 codex 即可开始：
codex
你也可以前往 最新的 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`。使用你的 ChatGPT 计划使用 Codex
运行 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 使用方法
- 使用提示作为输入运行
- 示例提示
- 使用 AGENTS.md 的记忆功能
- 配置
- 沙盒和批准
- 身份验证
- 认证方法
- 在"无头"机器上登录
- 自动化 Codex
- GitHub Action
- TypeScript SDK
- 非交互模式（
codex exec） - 高级功能
- 跟踪 / 详细日志记录
- 模型上下文协议 (MCP)
- 零数据保留 (ZDR)
- 贡献
- 安装和构建
- 系统要求
- DotSlash
- 从源代码构建
- 常见问题解答
- 开源基金
许可证
此仓库根据 Apache-2.0 许可证 许可。