Codex (GPT) 使用教程

OpenAI 推出的编程 AI 工具,任务完成细致,适合通用编程和代码生成场景

什么是 Codex?

Codex CLI 是 OpenAI 官方推出的命令行编程助手,基于 GPT-5 系列模型,在代码生成、调试和重构方面表现出色。

任务完成细致

OpenAI 出品,对需求理解精准,生成的代码质量高且符合最佳实践

🔧

通用编程能力强

支持 Python、JavaScript、TypeScript、Go、Rust 等主流编程语言

OpenAI 兼容接口

使用标准 OpenAI API 格式,可无缝对接 XiDao Api 中转服务

前置条件

依赖最低版本检查命令
Node.js18.0+node -v
Git2.23+git -v
💡
提示 如未安装 Node.js,请参考 Claude Code 教程中的安装步骤。

CLI 安装

bash
npm install -g @openai/codex

验证安装:

bash
codex --version

桌面端安装

Codex 桌面端是 OpenAI 推出的图形界面应用,提供更直观的可视化操作体验,支持多任务并行、沙箱隔离等高级功能。

🖥️

可视化界面

直观的 GUI 操作,无需记忆命令行参数,适合新手快速上手

🔄

多任务并行

支持同时运行多个 Agent 任务,大幅提升开发效率

🔒

沙箱隔离

原生沙箱机制,保护主机安全,防止 AI 误操作影响系统

下载安装

平台安装方式系统要求
macOS 官方 .dmg / Homebrew macOS 12.0+ (Monterey)
Windows MSI 安装包 / Microsoft Store Windows 10/11 (64-bit)
Linux CLI + IDE 插件(桌面版即将推出) Ubuntu/Debian/Fedora

macOS 安装步骤

1

访问官网下载

打开浏览器访问 OpenAI Codex 官方页面,下载 macOS 版本的 .dmg 安装包

2

安装应用

双击 .dmg 文件,将 Codex 拖入 Applications 文件夹完成安装

3

首次启动

从 Launchpad 或 Applications 启动 Codex,按提示完成初始化配置

💡
提示 也可以通过 Homebrew 快速安装:brew install --cask codex

Windows 安装步骤

1

下载安装包

访问 OpenAI 官网下载 Windows 版 MSI 或 EXE 安装包(也可从 Microsoft Store 安装)

2

运行安装程序

右键点击安装包,选择「以管理员身份运行」。如遇到 SmartScreen 警告,验证发布者后选择「仍要运行」

3

完成安装

按照安装向导提示完成安装,完成后可在开始菜单找到 Codex 应用

powershell
# PowerShell 静默安装(管理员权限)
$installer = "C:\path\to\Codex-Setup.exe"
Start-Process -FilePath $installer -ArgumentList "/S" -Wait

Linux 安装说明

目前 OpenAI 尚未正式发布 Linux 桌面版,但可以使用 CLI + IDE 扩展的方式获得完整体验:

bash
# 安装 Codex CLI
npm install -g @openai/codex

# 验证安装
codex --version

# 启动交互模式
codex
⚠️
注意 Linux 用户可以注册 OpenAI 的通知列表,等待官方桌面版发布。当前推荐使用 VS Code + Codex 扩展获得类似体验。

API 配置

Codex 使用 OpenAI 兼容接口,配置方式如下:

macOS / Linux

bash
export OPENAI_API_KEY="sk-你的API_KEY"
export OPENAI_BASE_URL="https://api.xidao.online/v1"

Windows (PowerShell)

powershell
$env:OPENAI_API_KEY = "sk-你的API_KEY"
$env:OPENAI_BASE_URL = "https://api.xidao.online/v1"
⚠️
重要 Windows 的 $env: 方式为临时配置,关闭终端后失效。URL 末尾需要加 /v1

持久化配置(推荐)

将环境变量写入 shell 配置文件(~/.zshrc、~/.bashrc 或 PowerShell Profile)即可持久化。

桌面端详细配置

Codex 桌面端提供多种配置方式,可根据使用场景选择最适合的方案。

首次登录与认证

首次启动 Codex 桌面端时,会弹出登录/认证窗口,提供两种模式:

👤

账号登录模式

  • 使用 ChatGPT/OpenAI 账号登录
  • 支持云端线程同步
  • 完整功能体验(推荐)
🔑

API Key 模式

  • 输入自定义 API Key
  • 适合使用第三方中转服务
  • 完全控制 API 端点
XiDao Api 用户 选择「API Key 模式」,输入你在 XiDao Api 控制台获取的 API Key 即可开始使用。

配置文件详解

Codex 桌面端的配置文件位于 ~/.codex/config.toml,支持高级自定义:

toml
# XiDao Api 配置示例 (~/.codex/config.toml)

# 默认模型提供商
model_provider = "xidao"

# 自定义提供商定义
[model_providers.xidao]
name = "XiDao Api"
base_url = "https://api.xidao.online/v1"
env_key = "OPENAI_API_KEY"

# 默认模型设置
model = "gpt-5.4"

# 个人配置文件(可选)
[profiles.default]
model_provider = "xidao"
model = "gpt-5.4"

# 高性能配置(可选)
[profiles.fast]
model_provider = "xidao"
model = "claude-sonnet-4-5-20250514"

环境变量配置(推荐)

通过环境变量配置是最简单可靠的方式,适用于所有平台:

变量名说明
OPENAI_API_KEY sk-xxxxxxxx 你的 XiDao Api 密钥
OPENAI_BASE_URL https://api.xidao.online/v1 API 基础地址(必须包含 /v1)

GUI 界面设置

在 Codex 桌面端应用内,可以通过 Settings 页面进行可视化配置:

1

打开设置

点击应用左下角的 ⚙️ 设置图标,或使用快捷键 Cmd+, (Mac) / Ctrl+, (Windows)

2

配置 Provider

在「Provider」选项卡中,选择 Custom,填写 Base URL 为 https://api.xidao.online/v1

3

填写 API Key

在 API Key 输入框粘贴你的 XiDao Api Key(sk-开头),点击 Save 保存

4

选择模型

在 Model 下拉菜单中选择你要使用的模型(如 gpt-5.4、claude-opus-4-7 等)

沙箱安全配置(Windows)

Windows 版 Codex 提供原生沙箱功能,保护系统安全:

🛡️

启用严格沙箱

Settings → Security → 启用 Strict Sandbox,限制 Agent 只能访问指定项目目录

📁

配置文件夹访问

在 Allowed Folders 列表中添加你需要让 Agent 访问的项目路径

PowerShell 集成

确保执行策略允许:Set-ExecutionPolicy RemoteSigned -Scope LocalMachine

WSL2 配置(可选,Windows 高级用户)

如果你的开发工具链基于 Linux,可以配置 Codex 使用 WSL2 运行 Agent 任务:

powershell
# 1. 安装 WSL2(如未安装)
wsl --install

# 2. 安装 Ubuntu 发行版(推荐)
wsl --install -d Ubuntu

# 3. 在 Codex Settings → Runtime 中:
#    - 选择 WSL 作为执行后端
#    - 指向默认 WSL 发行版(Ubuntu)
#    - Agent 任务将在 WSL 环境中运行
💡
提示 使用 WSL2 可以获得更好的 Linux 工具链兼容性,特别是需要使用 apt、pip、make 等工具时。

验证配置

完成配置后,可以通过以下方式验证是否成功:

bash
# 方法1:检查版本
codex --version

# 方法2:测试简单任务
codex "say hello"

# 方法3:检查登录状态
codex login status
配置成功标志 如果能看到正常的 AI 回复且无报错,说明配置成功!现在可以开始使用 Codex 进行开发了。

使用方法

启动交互模式

bash
codex

非交互模式(一次性执行)

bash
codex "帮我写一个快速排序算法"

# 带上下文
codex "解释这个项目的架构" --full-auto

管道输入

bash
cat main.py | codex "找出这段代码的问题并修复"

使用技巧

🎯

明确需求描述

详细描述你的需求,包括期望的编程语言、框架、功能点等,能获得更精准的结果

📝

分步执行复杂任务

对于大型功能,建议拆分为多个小步骤逐步完成,便于审查和控制质量

🔄

迭代优化

首次生成后可以要求调整和优化,如"改用异步方式"、"添加错误处理"等

提示 Codex 与 Claude Code 可以配合使用:用 Codex 进行代码生成,用 Claude Code 进行代码审查和重构。