Codex All-in-One for ArkClaw

让 ArkClaw / OpenClaw 用户在对话框里完成 Codex CLI 的全部配置 — 不用打开终端、不用写 config.toml、不用记 base_url。

整体流程(决策树)

用户触发本 skill(说"用 codex 帮我..." / "/codex-allinone ..." / 报错 等)
        │
        ▼
  ┌───────────────────────────┐
  │ 运行 scripts/doctor.sh    │  ← 每次触发都会运行,检测当前环境状态
  └─────────────┬─────────────┘
                │
       当前配置状态 = ?
                │
  ┌─────────────┼──────────────────────────────────┐
  │             │                                  │
"全新环境"    "本 skill 配过"                   "用户手动配过"
(从未配置)   (之前用本 skill 配置的)          (有 config.toml 但不是本 skill 写的)
  │             │                                  │
  ▼             ▼                                  ▼
路径 ①        路径 ②                             路径 ③
首次配置      正常使用(绝大多数情况)              兼容性检查
  │             │                                  │
  │             │                                  ├─ 检查通过 → 保留不动,转到路径 ②
  │             │                                  └─ 检查不通过 → 告知用户具体问题,
  │             │                                       询问是否用本 skill 重新配置
  │             │
问用户选择   自动确保服务就绪
A/B 菜单     然后执行: codex exec "用户的需求"
  │
  ▼
完成配置后
转到路径 ②

三条路径说明

重要:正常使用时不要打扰用户

当配置已经就绪(路径 ②)时,不允许:

• 复述配置流程
• 解释 skill 在做什么
• 询问"是否需要切换 / 是否需要重新配置"
• 把 skill 的存在感暴露给用户

只做:

1. 运行 bash scripts/ensure-relay.sh(自动按当前 profile 启对应端口的 relay,不需要时立即退出)
2. 执行 cd ~ && codex exec --skip-git-repo-check "用户的完整需求原文"
3. 把 codex 的输出原样返回给用户

用户体验应该等同于"直接跟 codex 对话",完全感觉不到 skill 的存在。

只有这三种情况允许打扰用户:

1. 首次配置(环境全新)
2. 兼容性检查不通过,且无法自动修复
3. 用户主动说"切换 / 换一家 / 切到 X"

触发方式

• 自然语言:"用 codex 帮我重构 utils.py" / "codex 跑一下这个测试"
• 显式命令:/codex-allinone \x3C你的编程需求>(强制走本 skill)
• 报错触发:用户贴出 command not found: codex / connection refused 444X 等

详细流程

Step 0 — 运行 doctor.sh 检测环境

每次触发都先运行 bash scripts/doctor.sh,它会输出一个 JSON,包含:

{
  "codex_installed": true,
  "codex_version": "0.130.x",
  "codex_outdated": false,
  "config_state": "clean | managed-by-skill | user-managed",
  "active_profile": "agentplan | kimi | deepseek | arkv3 | custom | null",
  "user_config_summary": {"model_provider": "...", "model": "..."} | null,
  "user_health": {"is_healthy": true/false, "checks": [...], "issues": [...]} | null,
  "expected_relay_port": 4446 | 4447 | 4448 | 4449 | null,
  "relay_running": true,
  "ark_api_key_set": true,
  "moonshot_api_key_set": false,
  "deepseek_api_key_set": false,
  "ark_v3_api_key_set": false,
  "custom_api_key_set": false,
  "issues": []
}

根据 config_state 决定走哪条路径。

Step 1 — 安装 / 升级 Codex CLI(仅首次需要)

scripts/install.sh 的行为:

Step 2 — 询问用户选择模型服务(仅路径 ① 触发)

向用户输出:

你想用哪种模型来驱动 Codex?

A. 火山方舟 AgentPlan(推荐)
   ✅ 套餐内额度,无需额外付费
   ✅ ark-code-latest 智能路由
   📋 需要"AgentPlan 控制台"分配的专属 Key

B. 第三方 OpenAI 兼容 Key
   ✅ 已经有 Kimi / DeepSeek / 自购方舟 Key,或公司自建网关等
   📋 需要你自己有这些 Key

请回复 A 或 B。

• 选 A → 引导粘贴 Key → 运行 bash scripts/setup-agentplan.sh "$KEY"
• 选 B → 展示二级菜单(具体哪家)→ 运行 bash scripts/setup-thirdparty.sh \x3Cprovider> "$KEY"

配置脚本会自动完成:写 Key → 写 profile → 按需启动 codex-relay → 写自动恢复命令到 .bashrc。如果用户已有 config.toml,会先备份再覆盖。

Step 3 — 兼容性检查(仅路径 ③ 触发)

当 doctor.sh 返回 config_state == "user-managed" 时,说明用户之前手动写过 config.toml。此时读取 user_health 字段:

检查通过(is_healthy == true):

• 不打扰用户,直接当作"已配好",进入正常使用

检查不通过(is_healthy == false): 向用户展示具体问题,并询问:

检测到你已有的 codex 配置存在以下问题:
  1. \x3C具体问题描述>
  2. \x3C具体问题描述>

你希望:
  A. 让本 skill 帮你重新配置(推荐,会先备份你现有的文件)
  B. 我自己去修改

请回复 A 或 B。

Step 4 — 正常使用

bash scripts/ensure-relay.sh
cd ~ && codex exec --skip-git-repo-check "用户的完整需求原文"

ensure-relay.sh 做什么?

• 读取 ~/.codex/active-profile,根据当前 profile 自动启对应端口的 codex-relay
• 端口分配:agentplan=4446 / kimi=4447 / deepseek=4448 / custom=4449
• arkv3(直连)和 custom 直连模式立即退出,不耗时

Step 5 — 切换模型服务(用户主动要求时)

bash scripts/switch-profile.sh        # 列出已配置的服务
bash scripts/switch-profile.sh kimi   # 切换到 Kimi

codex-relay 是什么?

Codex CLI 0.130+ 默认发 OpenAI Responses 协议,而多数模型服务只支持 Chat 协议。codex-relay 是一个轻量的本地服务,负责做协议翻译:

Codex CLI ──(Responses)──→ codex-relay (本机端口) ──(Chat)──→ 上游模型服务

每个 profile 占一个独立端口:

custom 路径的探测:POST {base_url}/responses 返回 404 → 不支持 → 走 relay;返回 200/400/401/403/422 → 支持 → 直连。

安装方式:

pip install --user --break-system-packages codex-relay

安装后可通过 codex-relay --help 验证。

健康检查都检查什么?

Profile 设计

每个模型服务在 ~/.codex/profiles/ 下有一个 .toml 配置文件:

~/.codex/profiles/
├── agentplan.toml    — 火山方舟 AgentPlan(经 relay 端口 4446)
├── kimi.toml         — Kimi (月之暗面 Moonshot,经 relay 端口 4447)
├── deepseek.toml     — DeepSeek(经 relay 端口 4448)
├── arkv3.toml        — 火山方舟普通 v3 Key(直连)
└── custom.toml       — 自定义 OpenAI 兼容端点(自动探测,直连或经 relay 端口 4449)

~/.codex/config.toml 是一个快捷方式(软链接),指向当前使用的配置文件。切换模型服务 = 把快捷方式指向另一个文件。

必读参考文档

安全规则

• 用户的 Key 只保存在 ~/.bashrc 和 ~/.codex/profiles/*.toml 中(用户家目录内)
• 覆盖配置前自动备份到 ~/.codex/config.toml.bak.\x3C时间戳>
• 不上传任何外部服务,不在日志中记录 Key 明文

不做什么

• ❌ 不尝试连接 OpenAI 官方服务(沙箱网络在境内 IDC,连不上 openai.com)
• ❌ 不自动猜测 Key,所有 Key 必须由用户主动粘贴
• ❌ 不做 Claude Code 的配置(那是另一个 skill)
• ❌ 不在用户没确认前覆盖已有的 config.toml

常用对话示例