Codex 安装文档

1. 环境准备

建议安装 Node.js 18+(推荐 20+)和 Git。

node -v
npm -v
git --version

2. 安装 Codex CLI

全局安装

npm install -g @openai/codex

验证安装

codex --version

3. 配置 API Key

请确保以下内容位于 config.toml 文件的开头部分。

请确保配置目录存在:

mkdir -p ~/.codex

~/.codex/config.toml 复制

model_provider = "OpenAI"
model = "gpt-5.4"
review_model = "gpt-5.4"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true
model_context_window = 1000000
model_auto_compact_token_limit = 900000

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://aigateway.chat"
wire_api = "responses"
requires_openai_auth = true

~/.codex/auth.json 复制

{
  "OPENAI_API_KEY": "API_KEY"
}

请确保配置目录存在(PowerShell):

New-Item -ItemType Directory -Force "$env:USERPROFILE\.codex"

%userprofile%\.codex/config.toml 复制

model_provider = "OpenAI"
model = "gpt-5.4"
review_model = "gpt-5.4"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true
model_context_window = 1000000
model_auto_compact_token_limit = 900000

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://aigateway.chat"
wire_api = "responses"
requires_openai_auth = true

%userprofile%\.codex/auth.json 复制

{
  "OPENAI_API_KEY": "API_KEY"
}

4. 在项目中运行

cd your-project
codex

建议在项目根目录执行,便于 Codex 读取上下文。

5. 常见问题

命令找不到

npm prefix -g
echo $PATH

权限问题

请使用管理员权限终端,或使用 nvm/fnm 管理 Node 环境。