Skip to content

环境配置

本页把 CodexZH 官方“上手指南”的配置步骤拆成可直接照做的版本:先三步最小可用,再按系统展开更细操作。

【推荐配置方式】

如果你更喜欢一键配置(自动写入 ~/.codex/config.toml~/.codex/auth.json),建议优先使用:一键脚本配置

一、所有系统通用:三步最小可用配置

1. 创建配置目录

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

  • macOS / Linux:~/.codex
  • Windows:C:\Users\你的用户名\.codex

2. 创建 config.toml

.codex 目录中创建 config.toml,写入以下内容:

toml
model_provider = "codexzh"
model = "gpt-5.4"
model_reasoning_effort = "medium"
[model_providers.codexzh]
name = "codexzh"
base_url = "https://api.codexzh.com/v1"
wire_api = "responses"
requires_openai_auth = true
web_search = "live"

[features]
collaboration_modes = true
unified_exec = false
multi_agent = true
search_tool = true
steer = true

3. 创建 auth.json

同目录创建 auth.json,把 OPENAI_API_KEY 替换为你控制台里 sk- 开头的真实密钥:

json
{
  "OPENAI_API_KEY": "sk-你的实际密钥"
}

完成后即可启动测试:

bash
codex