主题
Codex 使用指南
这份教程旨在让你在最短时间内完成 FlexAPI与Codex CLI 的对接。
右侧为页面导航，可根据需要直接导航到指定位置
Step 1: 获取 API Key
1. 登录 FlexAPI 控制台
前往 FlexAPI，登录并选择对应的分组，创建 FlexAPI API Key。
2. 充值额度或购买订阅
按照使用模式，选择按时长订阅或充值额度按量付费。
3. 获取 API Key
在控制台创建或复制你的 FlexAPI API Key，后续配置 CLI 和客户端时都要用到。
Step 2: 下载安装 Codex CLI
环境要求
- Node.js 18 或更高版本
- npm 或 yarn 包管理器
Node.js 18 或更高版本下载步骤
bash
# 方法一：通过 Homebrew 安装 Node.js LTS
brew install node
# 方法二：也可以访问 https://nodejs.org/ 下载 macOS LTS 安装包
# 下载 .pkg 文件后，按照安装向导完成安装
# 验证 Node.js 和 npm 是否安装成功
node --version
npm --version
echo "Node.js 安装成功：如果上方显示 v18 或更高版本，并显示 npm 版本号，说明环境已准备好。"bash
# 方法一：使用 NodeSource 官方仓库（推荐，Ubuntu / Debian）
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
# 方法二：使用系统包管理器
# Ubuntu / Debian
sudo apt update
sudo apt install -y nodejs npm
# CentOS / RHEL / Fedora
sudo dnf install -y nodejs npm
# 验证 Node.js 和 npm 是否安装成功
node --version
npm --version
echo "Node.js 安装成功：如果上方显示 v18 或更高版本，并显示 npm 版本号，说明环境已准备好。"powershell
# 方法一：通过 winget 安装 Node.js LTS
winget install OpenJS.NodeJS.LTS
# 方法二：也可以访问 https://nodejs.org/ 下载 Windows LTS 安装包
# 下载 .msi 文件后，按照安装向导完成安装
# 验证 Node.js 和 npm 是否安装成功
node --version
npm --version
Write-Host "Node.js 安装成功：如果上方显示 v18 或更高版本，并显示 npm 版本号，说明环境已准备好。"npm 或 yarn 包管理器下载步骤
npm 会随 Node.js 一起安装。如果你想使用 yarn，可以按下面步骤启用。
bash
# 验证 npm 是否可用
npm --version
echo "npm 已安装成功：如果上方显示版本号，可以直接使用 npm。"
# 可选：启用并安装 yarn
corepack enable
corepack prepare yarn@stable --activate
# 验证 yarn 是否安装成功
yarn --version
echo "yarn 安装成功：如果上方显示版本号，可以使用 yarn。"powershell
# 验证 npm 是否可用
npm --version
Write-Host "npm 已安装成功：如果上方显示版本号，可以直接使用 npm。"
# 可选：启用并安装 yarn
corepack enable
corepack prepare yarn@stable --activate
# 验证 yarn 是否安装成功
yarn --version
Write-Host "yarn 安装成功：如果上方显示版本号，可以使用 yarn。"安装步骤
如果你还没有安装 Codex CLI，可以先完成安装，再配置接入。
- 安装 Codex CLI
bash
npm install -g @openai/codex如遇权限问题：
- macOS / Linux：使用
sudo npm install -g @openai/codex - Windows：以管理员身份运行终端
- 验证安装
bash
codex --version输出为版本号，即为安装成功
检查
- 已安装 Node.js
- 可以在终端中正常运行
codex - 已准备好 FlexAPI API Key
若已完成上述准备，可进入下一步
Step 3: Codex CLI 配置
下载一键配置脚本
- Windows: 下载 codex-config.bat
- macOS / Linux: 下载 codex-config.sh
方式 1：使用一键配置脚本（推荐）
运行方法：
- Windows：双击
codex-config.bat或在终端执行./codex-config.bat - macOS / Linux：在终端执行
sh codex-config.sh
脚本可以在任意目录执行，会自动配置 CLI 环境。
开始使用
bash
codex方式 2：手动配置
- 打开文件资源管理器，找到
~/.codex文件夹（不存在则创建） - 创建
config.toml文件 - 使用文本编辑器打开，添加以下内容：
toml
model_provider = "flexapi"
model = "gpt-5.3-codex"
model_reasoning_effort = "high"
disable_response_storage = false
[model_providers.flexapi]
name = "FlexAPI"
base_url = "https://flexapi.me/v1"
wire_api = "responses"
requires_openai_auth = true创建 auth.json 文件：
json
{
"OPENAI_API_KEY": "your-flexapi-api-key"
}提示
将 your-flexapi-api-key 替换为 FlexAPI 的密钥
插件配置
支持的编辑器
安装步骤
下载并运行配置脚本，自动完成所有设置：
- Windows: 下载 codex-config.bat
- macOS / Linux: 下载 codex-config.sh
FAQ 常见问题
Q: 配置脚本必须在特定目录运行吗？
不需要。配置脚本可以在任意目录执行，会自动找到正确的配置位置。
Q: 如何选择 Base URL？
推荐使用 flexapi.me。
Q: 插件和 CLI 可以同时使用吗？
可以。两者使用相同的配置，互不影响。
Q: 远程开发（SSH）如何配置？
在远程服务器上运行配置脚本即可。VS Code 的远程扩展会自动使用远程服务器的配置。
Q: 配置后无法使用怎么办？
检查以下几点：
- API Key 是否正确复制（无多余空格）
- Base URL 是否配置正确
- 网络是否能访问 Codex 服务
- 重启编辑器或终端后重试
Q: 如何更新 API Key？
重新运行配置脚本，或在编辑器设置中手动更新。