Skip to content

Codex CLI 使用教程

Codex 是 OpenAI 官方的命令行 AI 编程助手,可以读取、修改和运行代码。它帮助你更快地构建功能、修复 bug,并理解不熟悉的代码。

快速开始

安装

npm 安装

bash
npm install -g @openai/codex

Homebrew 安装(macOS)

bash
brew install codex

运行

bash
codex

首次运行时会提示你进行认证。我们建议使用 ChatGPT 账号登录,因为它包含使用额度和最新功能。

文档目录

入门指南

参考文档

高级功能

平台和集成

安全和更新

配置示例

在用户目录下 ~/.codex/ 目录中创建配置文件:

config.toml

toml
# 模型配置
model = "gpt-5-codex"
model_provider = "openai"

# 审批和沙箱
approval_policy = "on-request"
sandbox_mode = "workspace-write"

# 推理配置
model_reasoning_effort = "medium"

环境变量配置

macOS 和 Linux

将以下内容添加到 ~/.zshrc(macOS)或 ~/.bashrc(Linux):

bash
export OPENAI_API_KEY="你的API密钥"

配置后重新加载配置文件:

bash
source ~/.zshrc  # macOS
source ~/.bashrc # Linux

Windows

使用 PowerShell 设置用户级环境变量:

powershell
[System.Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "你的API密钥", [System.EnvironmentVariableTarget]::User)

常用命令

bash
# 启动交互式会话
codex

# 快速问答
codex "解释这个代码库"

# 非交互式执行
codex exec "修复 CI 失败"

# 恢复会话
codex resume --last

# 代码审查
codex  # 然后输入 /review

相关资源

aicodex 文档网站