codex
在终端里运行的轻量级 AI 编码代理,OpenAI 官方开源,采用 Rust 编写,可直接通过命令行与 ChatGPT 计划或 API 对接完成代码任务。相比 IDE 插件方案更贴近命令行工作流,安装简单(curl/npm/brew 均可),当前热度高。仓库基于 Apache-2.0 协议开源,适合熟悉终端操作的开发者快速上手。
README
Codex CLI 是 OpenAI 的 coding agent(编码代理),在本地计算机上运行。
codex app 或访问 Codex App 页面。
如果你在寻找 OpenAI 的 云端 agent(代理)——Codex Web,请前往 chatgpt.com/codex。快速开始
安装并运行 Codex CLI
在 Mac 或 Linux 上运行以下命令来安装 Codex CLI:
curl -fsSL https://chatgpt.com/codex/install.sh | sh
在 Windows 上运行以下命令来安装 Codex CLI:
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"
默认情况下,独立安装程序从 https://releases.openai.com/codex 下载,如果元数据或资源下载不可用,则回退到 GitHub Releases。要强制使用 GitHub Releases,请将 CODEX_INSTALLER_USE_RELEASES_OPENAI_COM 设置为 false(也接受 0 和 no):
curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_INSTALLER_USE_RELEASES_OPENAI_COM=false sh
$env:CODEX_INSTALLER_USE_RELEASES_OPENAI_COM='false'; irm https://chatgpt.com/codex/install.ps1 | iex
Codex CLI 也可以通过以下包管理器安装:
# Install using npm
npm install -g @openai/codex
# Install using Homebrew
brew install --cask codex
然后直接运行 codex 即可开始。
每个 GitHub Release 都包含许多可执行文件,但在实践中,你可能需要以下之一:
- macOS
- Apple Silicon/arm64:
codex-aarch64-apple-darwin.tar.gz - x86_64(旧款 Mac 硬件):
codex-x86_64-apple-darwin.tar.gz
- Apple Silicon/arm64:
- Linux
- x86_64:
codex-x86_64-unknown-linux-musl.tar.gz - arm64:
codex-aarch64-unknown-linux-musl.tar.gz
- x86_64:
每个压缩包都包含一个单一文件,其名称中已包含平台信息(例如 codex-x86_64-unknown-linux-musl),因此你可能需要在解压后将其重命名为 codex。
将 Codex 与你的 ChatGPT 套餐配合使用
运行 codex,然后选择 使用 ChatGPT 登录。我们建议你登录 ChatGPT 账户,将 Codex 作为 Plus、Pro、Business、Edu 或 Enterprise 套餐的一部分来使用。了解更多 ChatGPT 套餐包含的内容。
你也可以使用 API key(API 密钥)使用 Codex,但这需要 额外设置。
文档
本仓库基于 Apache-2.0 License 许可证发布。