安装与登录

系统要求

平台Codex CLICodex App说明
macOSIntel / Apple Silicon
Windows原生 PowerShell 沙箱,或 WSL2 做 Linux 环境
Linux常用服务器与 CI

其他要求:

  • 网络可访问 OpenAI 服务
  • Git(推荐,用于 diff、checkpoint)
  • 终端:Windows Terminal、iTerm2、Kitty 等

安装 Codex CLI

方式一:官方安装脚本(推荐)

macOS / Linux:

curl -fsSL https://chatgpt.com/codex/install.sh | sh

Windows(PowerShell):

powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"

无人值守安装:

curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_NON_INTERACTIVE=1 sh

方式二:npm

npm install -g @openai/codex

方式三:Homebrew(macOS)

brew install --cask codex

验证

codex --version

登录方式

首次运行 codex 会提示登录,两种方式:

1. ChatGPT 账号(推荐个人开发者)

  • 使用 Plus / Pro 等含 Codex 的套餐
  • 自动配置 API Key,免去手动管理
  • 部分 Cloud 与额度政策与 API 不同,以官网为准

2. OpenAI API Key

  • 适合 CI、企业按量计费
  • platform.openai.com 创建 Key
  • 部分 ChatGPT 专属功能可能不可用

目录与环境变量

路径 / 变量含义
~/.codex/默认 Codex 主目录(CODEX_HOME 可覆盖)
~/.codex/config.toml用户级配置
~/.codex/AGENTS.md全局 Agent 指令
CODEX_HOME指向另一套配置(多 profile、自动化用户)
CODEX_NON_INTERACTIVE安装脚本非交互模式

安装 IDE 扩展(可选)

  • VS Code
  • Cursor、Windsurf、VS Code Insiders

安装后在侧边栏打开 Codex 面板,使用 ChatGPT 或 API Key 登录。默认 Agent 模式 可读写项目目录。


安装 Codex App(可选)

Codex Quickstart 下载 macOS / Windows 安装包,选择项目文件夹,在 Local 模式下发送第一条消息。


常见问题

codex: command not found

  • 确认安装脚本已将二进制加入 PATH
  • npm 全局:npm prefix -g 应在 PATH 中

Windows 上 Shell 行为异常

  • 优先使用官方 Windows 沙箱文档:Windows setup
  • 需要 Linux 原生工具链时用 WSL2

登录失败或 401

  • 检查系统时间、代理、防火墙
  • API Key 是否过期、组织是否启用 Codex

下一步