Coding Flow

中文

English

中文

English

主题

Coding Flow2026-03-16
993
4.2m

Codex 配置教程 ​

安装并配置 Codex CLI 工具，通过配置文件连接 Coding Flow 平台。

Codex 是支持 OpenAI API 兼容接口的 CLI 工具，使用配置文件的方式进行设置。本教程将引导你完成安装和配置。

开始前请先完成 Node.js 环境安装教程。

你需要准备

  • 一个可用的 API Key（形如：sk-******）
  • 一个可访问的 服务地址（Base URL）（通常由部署方/网关提供）

本站通用服务地址

第一步：安装 Codex ​

控制台中输入以下命令会从 npm 官方仓库下载并安装最新版本的 Codex 工具。

Windows
npm install -g @openai/codex@latest
Linux
sudo npm install -g @openai/codex@latest
macOS
sudo npm install -g @openai/codex@latest

验证安装

安装完成后，输入以下命令检查，如果显示版本号，说明安装成功了！

Bash
codex --version

第二步：创建配置文件 ​

Codex 使用配置文件进行连接设置，需要创建 config.toml 和 auth.json 两个文件。

创建配置目录 ​

Windows
# 删除旧目录并创建新目录
if (Test-Path "$env:USERPROFILE\.codex") { Remove-Item -Recurse -Force "$env:USERPROFILE\.codex" }
mkdir "$env:USERPROFILE\.codex"
Linux
# 删除旧目录并创建新目录
rm -rf ~/.codex && mkdir -p ~/.codex
macOS
# 删除旧目录并创建新目录
rm -rf ~/.codex && mkdir -p ~/.codex

创建配置文件 ​

Windows
# 创建 config.toml
@"
model_provider = "codingflow"
model = "gpt-5.4"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.codingflow]
name = "codingflow"
base_url = "https://api.codingflow.ai/v1"
wire_api = "responses"
requires_openai_auth = true
"@ | Out-File -FilePath "$env:USERPROFILE\.codex\config.toml" -Encoding utf8

# 创建 auth.json
@"
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
"@ | Out-File -FilePath "$env:USERPROFILE\.codex\auth.json" -Encoding utf8
Linux
# 创建 config.toml
cat > ~/.codex/config.toml << 'EOF'
model_provider = "codingflow"
model = "gpt-5.4"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.codingflow]
name = "codingflow"
base_url = "https://api.codingflow.ai/v1"
wire_api = "responses"
requires_openai_auth = true
EOF

# 创建 auth.json
cat > ~/.codex/auth.json << 'EOF'
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
EOF
macOS
# 创建 config.toml
cat > ~/.codex/config.toml << 'EOF'
model_provider = "codingflow"
model = "gpt-5.3-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.codingflow]
name = "codingflow"
base_url = "https://api.codingflow.ai/v1"
wire_api = "responses"
requires_openai_auth = true
EOF

# 创建 auth.json
cat > ~/.codex/auth.json << 'EOF'
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
EOF

重要提示

请将 YOUR_API_KEY 替换为在 Coding Flow平台 申请的 API Key。

以上配置参数说明

  • config.toml: 配置文件，指定了模型提供者、模型名称、推理难度、禁用响应存储、认证方式等信息。
  • model_provider: 模型提供者名称，固定设置为 codingflow。
  • model: 模型名称，指定使用具体模型，例如 gpt-5.4。
  • model_reasoning_effort: 模型推理难度，可以设置为 high、medium 或 low。
  • disable_response_storage: true 代表禁止存储API响应，不保存历史记录。
  • preferred_auth_method: 认证方式，此处为 apikey。
  • [model_providers.codingflow]: 模型提供者配置。
  • name: 模型提供者名称，固定设置为 codingflow。
  • base_url: 模型提供者的 API 地址，固定设置为 https://api.codingflow.ai/v1。
  • wire_api: 指定API接口类型。
  • requires_openai_auth: 是否需要 OpenAI 认证。
  • OPENAI_API_KEY: 认证密钥，此处为 YOUR_API_KEY。

第三步：开始使用 ​

Bash
codex

常见问题 ​

Q: The encrypted content gAAA...uw== could not be verified. Reason: Encrypted content could not be decrypted or parsed ​

A: 交互时加解密使用的密钥不一致。此时可以尝试关闭对话并清理缓存，然后重新开始一个新对话即可。


Q: 配置脚本必须在特定目录运行吗？ ​

A: 不需要。配置脚本可以在任意目录执行，会自动找到正确的配置位置。


Q: 插件和 CLI 可以同时使用吗？ ​

A: 可以。两者使用相同的配置，互不影响。


Q: 远程开发（SSH）如何配置？ ​

A: 在远程服务器上运行配置脚本即可。VS Code 的远程扩展会自动使用远程服务器的配置。


Q: 配置后无法使用怎么办？ ​

A: 检查以下几点：

  • API Key 是否正确复制（无多余空格）
  • Base URL 是否配置正确
  • 网络是否能访问 Codex 服务
  • 重启编辑器或终端后重试

Q: 如何更新 API Key？ ​

A: 重新运行配置脚本，或在编辑器设置中手动更新。