Codex入门读者更新于

Codex 安装与配置

OpenAI 代码助手,强大的 AI 编程工具。

请先完成「环境准备」章节,确保 Node.js 和 npm 已安装。

已经完成安装,需要理解模型、Provider、权限、会话和 Token 配置时,请继续阅读 Codex config.toml 进阶指南。


Linux / MacOS 配置

步骤 1: 安装 Codex

npm install -g @openai/codex@latest

步骤 2: 创建配置文件夹

在用户目录下创建 .codex 文件夹。

mkdir -p ~/.codex

步骤 3: 创建 config.toml

在 .codex 文件夹里创建 config.toml 文件,并填入下面的内容:

model_provider = "icodeeasy"
model = "gpt-5.6-sol"
cli_auth_credentials_store = "file"
suppress_unstable_features_warning = true
personality = "pragmatic"

[model_providers.icodeeasy]
name = "icodeeasy"
base_url = "https://api.icodeeasy.cc"
wire_api = "responses"
requires_openai_auth = true

如果 api.icodeeasy.cc 连接慢,可以把 base_url 换成 https://jp.icodeeasy.cc 或 https://sg.icodeeasy.cc。

步骤 4: 登录并生成 auth.json

到 密钥设置 复制 API Key,然后在终端运行以下命令。粘贴后按 Enter; 输入不会显示,也不会把密钥保存到 shell 启动文件:

read -s OPENAI_API_KEY
printf '\n'
printf '%s' "$OPENAI_API_KEY" | codex login --with-api-key
unset OPENAI_API_KEY
codex login status

Codex 会把凭据写入 ~/.codex/auth.json。不要手工创建或编辑该文件;config.toml 负责模型与 Provider,auth.json 只负责登录凭据。建议确认两个文件仅当前用户可读写:

chmod 600 ~/.codex/config.toml ~/.codex/auth.json

步骤 5: 启动 Codex

cd your-project-folder
codex

Windows 配置

步骤 1: 安装 Codex

npm install -g @openai/codex@latest

步骤 2: 创建配置文件夹

查看用户目录:

echo $env:USERPROFILE

在用户目录下创建 .codex 文件夹:

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

步骤 3: 创建 config.toml

在 .codex 文件夹里创建 config.toml 文件,并填入下面的内容:

model_provider = "icodeeasy"
model = "gpt-5.6-sol"
cli_auth_credentials_store = "file"
suppress_unstable_features_warning = true
personality = "pragmatic"

[model_providers.icodeeasy]
name = "icodeeasy"
base_url = "https://api.icodeeasy.cc"
wire_api = "responses"
requires_openai_auth = true

[features]
elevated_windows_sandbox = true

如果 api.icodeeasy.cc 连接慢,可以把 base_url 换成 https://jp.icodeeasy.cc 或 https://sg.icodeeasy.cc。

步骤 4: 登录并生成 auth.json

到 密钥设置 复制 API Key,然后运行:

$secureKey = Read-Host "API Key" -AsSecureString
$plainKey = [System.Net.NetworkCredential]::new("", $secureKey).Password
$plainKey | codex login --with-api-key
$plainKey = $null
codex login status

Codex 会把凭据写入 $env:USERPROFILE\.codex\auth.json。不要手工创建或编辑该文件, 也不需要设置永久的 OPENAI_API_KEY 用户环境变量。

步骤 5: 启动 Codex

新开一个 PowerShell,进入工程目录并启动:

cd your-project-folder
codex

VSCode 配置

请先按上面的步骤配置好 Codex CLI,并确认 codex login status 成功。VSCode 扩展会复用同一用户目录下的 config.toml 和 Codex 缓存的登录凭据。

步骤 1: 安装 Codex 扩展

在 VSCode 扩展市场搜索并安装 Codex。

步骤 2: 打开配置文件

Codex VSCode 扩展会复用用户目录下的 .codex/config.toml 配置。请按上面的 Linux / MacOS 或 Windows 步骤创建 .codex 文件夹和 config.toml 文件。

步骤 3: 配置 API Key

通常不需要再次输入 API Key。如果扩展仍提示登录,请先在 VSCode 集成终端运行 codex login status,再执行 Developer: Reload Window。