openrig 配置编排指南：用 YAML 统一管理 Claude Code 与 Codex

1. openrig 到底是个什么东西第一次看到 openrig 这个名字我下意识以为是某个硬件机架项目毕竟 rig 这个词在矿机、电台、测试设备圈子里太常见了。翻了翻社区里的讨论和几个仓库的 README 之后才反应过来它其实是围绕 Claude Code、Codex 这类命令行 AI 编程助手做的一套配置编排方案核心载体是一份 YAML 文件运行环境是 Node.js。说白了openrig 想解决的是同一个问题当你手上有 Claude Code、Codex、还有一堆第三方模型端点的时候怎么用一套统一的配置把它们管起来而不是每换一个工具就重新配一遍环境变量、重新登录一次。这个痛点我自己踩过。早些年用 Claude Code 的时候配置散落在 shell 的 rc 文件、项目根目录的隐藏配置、还有工具自己的全局配置里换台机器就得重新捋一遍。后来 Codex 出来了又是一套独立的配置逻辑。再后来想接本地模型或者第三方端点环境变量名、base URL 格式、模型标识符写法各家都不一样稍微写错一个字符就是一句冷冰冰的报错。openrig 这类项目的价值就在于把这些碎片收敛到一份声明式的 YAML 里让配置变成可版本控制、可复制、可审查的东西。它适合谁我的判断是三拨人。第一拨是同时用多个 AI 编程工具的开发者尤其是那种今天用 Claude Code 写业务逻辑、明天用 Codex 跑重构的场景。第二拨是需要把工具配置纳入团队规范的人一份 YAML 提交到仓库里新人 clone 下来就能跑不用口口相传。第三拨是喜欢折腾本地模型和第三方端点的人openrig 这种声明式结构比手写环境变量清爽太多。如果你只是偶尔用一下某个工具、从不换配置那这东西对你的边际收益不大但只要你开始同时维护两套以上的配置它就开始值钱了。需要先说明一点openrig 目前并不是一个官方标准社区里同名或近名的项目有好几个实现细节各有差异。下面我讲的是这类工具共通的设计思路和落地方法具体字段名以你实际拿到的版本为准。这个前提很重要不然你照着某一份配置抄结果字段对不上会以为是工具坏了。2. 为什么是 YAML 加 Node.js 这套组合2.1 YAML 作为配置载体的取舍选 YAML 不是随便定的。这类工具要描述的东西天然是嵌套结构一个顶层配置下面挂着多个 provider每个 provider 下面又有端点、模型列表、认证方式、超时参数。JSON 能表达同样的结构但手写 JSON 的体验太差不能写注释、不能有尾逗号、括号一多就容易看花眼。TOML 在扁平配置上很舒服但嵌套深了之后表头会变得很啰嗦。YAML 刚好卡在中间缩进即层级注释随便写多行字符串也友好特别适合写这种配置树。但 YAML 的坑也是真多这一点我必须提前说。缩进用空格不能用 Tab这是老生常谈但真正坑人的是它对特殊字符的处理。比如模型名里带冒号、URL 里带#、字符串以或%开头这些在 YAML 里都有特殊含义不引号包起来就会解析出错。我见过最典型的一次是某个端点的 URL 里带了查询参数结果后面的内容被当成了锚点引用整个配置加载失败报错信息还指向了完全不相干的行号。所以我的习惯是凡是字符串值只要不是纯字母数字加连字符一律用双引号包起来宁可多打两个引号也别跟解析器斗智斗勇。还有一个容易被忽略的点是 YAML 的布尔值陷阱。yes、no、on、off、true、false在 YAML 1.1 里都会被解析成布尔值如果你某个字段的值恰好是on这种字符串就会被静默转成true。这个坑在配置开关类字段上特别隐蔽因为类型错了不一定报错可能只是行为不对。规避方法同样是加引号。2.2 Node.js 作为运行时的现实考量为什么是 Node.js 而不是 Python 或 Go我的理解是生态惯性。Claude Code 和 Codex 这类工具本身就是 npm 生态里的东西安装方式就是npm install -g用户机器上大概率已经有 Node.js 了。openrig 作为编排层复用同一个运行时能省掉一整套依赖安装的麻烦。如果它用 Python 写那用户就得同时维护 Node 和 Python 两套环境配置工具本身反而成了负担。Node.js 版本这块有个高频报错值得单独拎出来说。社区里经常看到类似error installing 24.21.0: node.js v24.21.0 is not yet released or is not available这种信息本质上是版本号写错了或者指定的版本在对应平台上还没有预编译包。我的建议是别追最新的大版本用 LTS 就行。截至我写这篇的时候Node.js 20 和 22 的 LTS 线都比较稳装的时候直接去官网下载 LTS 安装包或者用 nvm 这类版本管理器切换。用 nvm 的好处是可以在多个项目之间切版本不会因为全局升级把老项目搞崩。# 用 nvm 安装并切换到 LTS 版本 nvm install --lts nvm use --lts node -v npm -v装完之后node -v能正常输出就说明运行时没问题。这里有个细节如果你在 Windows 上用的是官网的 msi 安装包装完之后可能需要重开一个终端窗口环境变量才会生效。我遇到过好几次在旧终端里敲node提示找不到命令换个窗口就好了白白浪费十分钟。2.3 声明式配置相比命令式脚本的优势有人会问我直接写个 shell 脚本里面一堆export不也能达到目的吗能但有几个本质区别。声明式配置描述的是最终状态是什么命令式脚本描述的是一步步怎么做。前者可以反复执行、幂等、容易 diff后者一旦中间某步失败状态就处于半吊子。更重要的是YAML 配置可以被程序读取和校验工具能在启动前就告诉你哪个字段类型不对、哪个必填项缺失而 shell 脚本只能跑到那一步才炸。从团队协作角度看一份 YAML 提交到 Git 里code review 的时候能清楚看到谁改了哪个端点的配置回滚也方便。shell 脚本里混着环境变量、路径拼接、条件判断review 起来很痛苦。这是我个人最看重的一点配置即文档配置即契约。3. 核心配置结构拆解与字段含义3.1 顶层结构长什么样一份典型的 openrig 风格配置顶层大概会分成几个区块全局设置、provider 列表、以及每个工具自己的映射规则。我用一个抽象的例子来说明结构具体字段名请对照你手上的版本文档。version: 1 defaults: timeout: 60 retries: 2 providers: - name: claude-main type: anthropic endpoint: https://api.example.com apiKeyEnv: CLAUDE_API_KEY models: - claude-sonnet - name: codex-main type: openai-compatible endpoint: https://api.example.com/v1 apiKeyEnv: CODEX_API_KEY models: - gpt-5.6-sol tools: claude-code: provider: claude-main codex: provider: codex-main这个结构里providers是核心每个 provider 描述一个可用的模型服务端点。apiKeyEnv这种设计很关键它不把密钥明文写在配置里而是引用一个环境变量名实际密钥从环境里读。这样做的好处是配置文件可以安全地提交到仓库密钥通过 CI 的 secret 或者本地的 shell 环境注入。我强烈建议所有涉及密钥的字段都走这个模式别图省事直接写明文一旦仓库权限没管好就是事故。tools区块做的是映射把具体的工具名绑定到某个 provider 上。这样切换工具用哪个端点只需要改这一处映射不用去动 provider 本身的定义。这种分层的好处是 provider 可以复用比如 Claude Code 和 Codex 都想用同一个第三方端点那就定义一次 provider在 tools 里分别指过去就行。3.2 provider 字段的细节讲究type字段决定了这个 provider 走哪套协议。anthropic和openai-compatible是最常见的两类前者对应 Claude 系列的原生接口后者对应一大票兼容 OpenAI 接口规范的第三方服务。这里有个高频坑很多第三方端点号称兼容 OpenAI但实际在/responses这类路径上的行为跟官方有细微差异比如返回结构里少字段、错误码不规范、流式输出的分块边界不一样。社区里那句cc switch local proxy failed while handling codex endpoint /responses就是这类问题的典型表现代理层按官方规范解析响应结果对端返回的东西不符合预期直接抛错。遇到这种情况排查顺序我一般是这样的先用 curl 直接打这个端点看原始返回长什么样确认是端点本身的问题还是代理层解析的问题。如果 curl 能通、代理层报错那就是兼容性差异得看代理有没有提供兼容模式开关。如果 curl 都不通那就是端点地址、认证或者网络的问题跟代理无关。models列表也值得说。有些端点对模型名的校验很严格写错一个字符就返回model is not supported。像gpt-5.6-sol这种带版本号的模型标识不同端点可能要求不同的写法有的要带前缀有的要带日期后缀。我的做法是先在端点的文档或者控制台里确认准确的模型标识再填进配置别凭记忆写。3.3 环境变量注入的几种方式密钥和端点地址这类敏感或环境相关的值通过环境变量注入是最稳妥的。注入方式有好几种各有适用场景。第一种是直接在 shell 里 export适合临时调试。缺点是关掉终端就没了而且容易在 history 里留下痕迹。export CLAUDE_API_KEYyour-key-here第二种是写进 shell 的 rc 文件比如.bashrc或.zshrc适合个人长期使用。缺点是所有终端会话都会加载如果密钥泄露影响面大。第三种是用.env文件配合工具加载适合项目级配置。.env文件记得加进.gitignore别提交上去。第四种是 CI/CD 里的 secret 注入适合自动化场景。这种方式最安全因为密钥从不落到磁盘上。我个人的习惯是本地开发用.env文件配合 direnv 这类工具在进入目录时自动加载CI 里用平台提供的 secret 机制。两种场景都不把密钥写死在配置里。注意不管用哪种方式都别把密钥提交到 Git 仓库。哪怕后来删掉了历史记录里还在清理起来很麻烦。提交前用git diff --cached扫一眼确认没有敏感信息。4. 从零搭建一套可用的配置4.1 环境准备与依赖安装动手之前先把地基打好。第一步确认 Node.js 装好了版本用 LTS。第二步确认 npm 能用。第三步如果是全局安装 openrig 这类工具确认全局 bin 目录在 PATH 里。node -v npm -v npm config get prefixnpm config get prefix输出的路径应该在 PATH 里否则全局安装的命令会找不到。Windows 上这个路径通常是用户目录下的AppData\Roaming\npmmacOS 和 Linux 上通常是/usr/local或者 nvm 管理的目录。如果不在 PATH 里手动加一下。安装 openrig 本身如果它发布在 npm 上就是一条命令的事npm install -g openrig装完之后openrig --version验证一下。如果提示命令找不到八成是 PATH 的问题回到上一步检查。4.2 编写第一份配置文件配置文件放哪我的建议是放在项目根目录命名成openrig.yaml或者.openrig/config.yaml具体看工具的约定。放项目根目录的好处是跟代码一起版本控制团队共享方便。写配置的时候我习惯从最小可用版本开始先跑通一个 provider再往上加。一上来就写五六个 provider出错了都不知道是哪个的问题。version: 1 providers: - name: primary type: anthropic endpoint: https://api.example.com apiKeyEnv: PRIMARY_API_KEY models: - claude-sonnet tools: claude-code: provider: primary这份配置只定义了一个 provider绑定给 Claude Code。先把这个跑通确认能正常调用再考虑加第二个。写完配置之后大多数工具会提供一个校验命令比如openrig validate或者openrig check。跑一下让它帮你检查语法和字段。这一步能挡掉大部分低级错误比如缩进错了、字段名拼错了、必填项漏了。4.3 密钥注入与首次连通性测试配置校验通过之后注入密钥。假设用.env文件# .env PRIMARY_API_KEYsk-xxxxxxxx然后加载这个文件。如果用 direnv进目录自动加载如果手动source .env或者用工具自带的加载机制。接下来做连通性测试。最直接的办法是用工具自己的命令发一个最简单的请求比如让 Claude Code 执行一个echo hello之类的无害命令看它能不能正常返回。如果报认证错误检查密钥对不对、有没有多余的空格或换行。如果报网络错误检查端点地址和网络连通性。如果报模型不支持检查模型标识符。我踩过的一个坑是密钥末尾多了个换行符从某个网页复制的时候带进来的结果认证一直失败排查了半天才发现。所以复制密钥之后最好用echo -n $PRIMARY_API_KEY | wc -c看一下字符数对不对或者直接cat -A看有没有隐藏字符。4.4 多工具共存的配置策略当你同时用 Claude Code 和 Codex 的时候配置策略有两种。一种是每个工具一个独立的 provider互不干扰另一种是共享 provider只是 tools 映射不同。独立 provider 的好处是隔离性好一个工具出问题不影响另一个。共享 provider 的好处是配置简洁改一处两个工具都生效。我的选择是如果两个工具用的是同一个端点就共享如果是不同端点就独立。别为了省几行配置强行共享最后端点行为不一致反而更难排查。providers: - name: shared-endpoint type: openai-compatible endpoint: https://api.example.com/v1 apiKeyEnv: SHARED_API_KEY models: - model-a - model-b tools: claude-code: provider: shared-endpoint model: model-a codex: provider: shared-endpoint model: model-b这种写法下两个工具共用一个端点但各自指定不同的模型。切换模型只需要改 tools 里的model字段不用动 provider。5. 常见报错与排查实录5.1 配置解析类错误YAML 解析错误是最常见的一类报错信息通常会给出行号和列号但有时候指向的位置不是你真正出错的地方。比如缩进错了一级解析器可能要到下一行才发现结构不对报错行号就偏了。我的排查习惯是从报错行往上找三到五行看有没有缩进不一致或者漏了冒号的地方。另一个高频问题是 Tab 和空格混用。有些编辑器默认用 Tab 缩进肉眼看不出来但 YAML 解析器会直接报错。解决办法是把编辑器设成Tab 转空格或者用cat -A看文件里有没有^I这种 Tab 标记。# 检查文件里有没有 Tab 字符 grep -P \t openrig.yaml如果输出有内容说明有 Tab得替换成空格。5.2 认证与端点类错误认证失败的表现通常是 401 或 403。排查顺序密钥是否存在、密钥是否正确、密钥是否有权限访问目标模型、端点地址是否正确。有时候密钥是对的但端点地址写成了另一个环境的也会认证失败。端点类错误里/responses路径相关的报错值得单独说。这个路径在 OpenAI 兼容接口里承担的是对话补全的职责不同实现对它的支持程度不一样。有的端点只支持/chat/completions不支持/responses那配置里就得指定用哪个路径。有的端点两个都支持但行为有差异。遇到failed while handling codex endpoint /responses这类报错先确认端点支持哪个路径再在配置里对应调整。5.3 模型标识与版本类错误model is not supported这类报错九成是模型标识写错了。解决办法是去端点的模型列表接口拉一下看准确的标识是什么。有些端点提供/models接口直接 curl 一下就能看到所有可用模型。curl -s -H Authorization: Bearer $API_KEY https://api.example.com/v1/models返回的列表里id字段就是你要填进配置的模型标识。别凭记忆写也别照抄别人的配置因为不同端点的模型标识可能不一样。5.4 常见问题速查表报错关键词可能原因排查方向YAML parse error缩进、Tab、特殊字符检查报错行上下几行用引号包裹特殊值401 / 403密钥错误或缺失检查环境变量是否加载密钥有无隐藏字符model is not supported模型标识错误拉取端点模型列表核对准确标识/responses failed端点路径不兼容确认端点支持的路径调整配置command not foundPATH 未配置检查 npm 全局 bin 目录是否在 PATHnode version errorNode 版本不匹配切换到 LTS 版本提示排查的时候养成从最外层往里查的习惯。先确认 Node 和工具本身能跑再确认配置能解析再确认密钥能加载最后才查端点和模型。顺序反了容易在细节里绕圈。6. 实操心得与避坑经验配置这东西文档里写的都是理想情况真正踩坑都是在细节上。我把自己和社区里反复出现的问题整理了几条都是那种知道了能省半天的经验。第一条配置文件一定要纳入版本控制但密钥绝对不能。这两件事不矛盾配置结构进仓库密钥走环境变量。我见过有人把密钥写在配置里然后提交发现之后删掉重新提交以为没事了其实历史记录里还在。正确做法是用git filter-repo这类工具清理历史或者干脆轮换密钥。第二条改配置之前先备份。YAML 改坏了工具直接起不来有个备份能快速回滚。我习惯用 Git 管理配置每次改动都是一个 commit出问题git checkout一下就回来了。第三条别在配置里写死跟环境相关的东西。比如本地开发用的端点地址和 CI 里用的不一样那就用环境变量区分别写死在 YAML 里。这样同一份配置能在不同环境复用。第四条模型标识和端点地址这类值从源头复制别手打。手打一个字符错了报错信息还不一定指向那里排查成本很高。第五条遇到兼容性问题先用 curl 绕过所有中间层直接打端点。这样能快速定位问题出在端点本身还是工具链的某一层。这个剥洋葱式的排查方法在多层代理的场景下特别管用。第六条Node.js 版本别追新。LTS 线经过充分测试稳定性有保障。追最新版可能遇到依赖还没适配的情况白白浪费时间。第七条配置里的超时和重试参数别设太激进。超时太短网络稍微抖一下就失败重试太多遇到真正的错误会反复重试拖慢排查。我的经验值是超时 60 秒、重试 2 次大部分场景够用。这套东西搭起来之后日常使用其实很省心。配置一次之后换工具、换模型、换端点都只是改几行 YAML 的事。真正花时间的永远是第一次搭建和踩坑把坑填平了后面就是顺水推舟。我现在手上同时维护着几套不同环境的配置靠的就是这套声明式的思路比当年手写环境变量的日子清爽太多了。