Codex --output-schema 强制输出结构化 JSON 怎么用:在自动化脚本里提取标准格式代码审查报告

在脚本或 CI 里调用 codex exec 怕返回自由格式 Markdown 难以解析?本文按官方文档详解 --output-schema 参数用法、JSON Schema 必填约束、与 --json 事件流的区别,附代码审查提取模板。

NNathaniel bigo··原创首发·AI 辅助撰写
10 分钟读完
资料核对于 2026-11-18 · 依据官方文档与公开资料整理 Plus 账号

结论先说

  1. --output-schema <路径> 用于强制约束 codex exec 的最终输出结构。按官方文档说明,传入 Schema 文件后,模型在标准输出(stdout)返回的最终结果会严格匹配定义好的字段名与类型。
  2. 它和 --json 参数用途完全不同。--output-schema 把最终答案变成单个业务 JSON 对象;而 --json 是把整个执行期间的会话启动、工具调用和消息输出变成逐行 JSONL 事件流。
  3. 编写 Schema 时每个对象层级都要写严约束。参照 OpenAI 结构化输出规范,根对象及嵌套对象均需设置 additionalProperties 为 false,并把当前层所有属性列入 required 数组。
  4. 提取报告时建议搭配 --sandbox read-only。只读沙箱能防止 Codex 在分析过程中修改业务代码,保证流水线检查安全可控。
  5. 自动化审查流水线对账号额度消耗较集中。国内缺少外币卡或绑卡受阻的用户,可在本站自助开通 ChatGPT Plus 或更高额度的 ChatGPT Pro,团队集中采购可咨询 ChatGPT Business 团队定制。

codex --output-schema 四步用法

图:本站根据 OpenAI Codex 官方文档:Non-interactive mode 整理的示意图

本文根据 OpenAI Codex 官方文档《Non-interactive mode》《Command line options》及 OpenAI API《Structured Outputs》指南整理,资料核对于 2026-11-18。配图为本站整理的示意图,不是界面截图。本站(bigolab.com)不是 OpenAI 官方网站。

适用于谁

  • 在 GitHub Actions、GitLab CI 或本地脚本里调用 codex exec,需要下游程序稳定解析返回字段的开发者;
  • 用提示词要求只输出 JSON,却仍偶发遇到多余代码块围栏或字段缺漏的人;
  • 分不清 codex exec 里 --output-schema 与 --json 两个参数各自用途的用户。

一、--output-schema 与 --json 参数对比

查阅命令帮助(见 /guides/codex-cli-commands-cheatsheet)时容易混淆这两个选项,核心差异如下:

对比项--output-schema ./schema.json--json
输出格式单个符合自定义 Schema 的 JSON 对象多行换行分隔的 JSONL 系统事件流
关注重点业务结论的字段结构(如问题列表、严重级别)运行全链路轨迹(思考、读文件、跑命令事件)
下游解析方式直接交给 jq 或脚本 json.load 解析按行流式读取并过滤末尾完成事件
典型场景自动生成审查单、变更元数据、风险评级卡自研外部监控面板、审计代理每一步动作

若业务脚本只关心最终审查结论,直接使用 --output-schema 最稳妥。底层 Schema 语法规则可参考 /guides/openai-api-structured-outputs。

二、实战步骤:提取标准格式代码审查报告

第 1 步:生成 review-schema.json

在项目根目录用 Python 生成标准 Schema 文件,确保根类型为 object 且所有属性列入 required:

python
import json

schema = dict(
    type='object',
    additionalProperties=False,
    required=['passed', 'summary', 'issues'],
    properties=dict(
        passed=dict(type='boolean'),
        summary=dict(type='string'),
        issues=dict(
            type='array',
            items=dict(
                type='object',
                additionalProperties=False,
                required=['file', 'line', 'severity', 'reason'],
                properties=dict(
                    file=dict(type='string'),
                    line=dict(type='integer'),
                    severity=dict(type='string', enum=['high', 'medium', 'low']),
                    reason=dict(type='string'),
                ),
            ),
        ),
    ),
)
json.dump(schema, open('review-schema.json', 'w', encoding='utf-8'), indent=2)

第 2 步:结合 git diff 执行审查并做门禁判断

bash
git diff origin/main...HEAD | codex exec \
  --sandbox read-only \
  --output-schema ./review-schema.json \
  "审查当前分支相对于 main 的变更。存在 high 级别缺陷时将 passed 设为 false,用中文填写 summary 与 reason。" \
  > review-report.json

jq -e '.passed == true' review-report.json >/dev/null || exit 1

专用审查命令对比也可查看 /guides/codex-code-review。

订阅与账号准备提示:在本地和脚本里批量跑结构化代码审查会持续占用模型推理配额。遇到额度见底时,可在本站自助升级 ChatGPT Pro 充值 或选用 ChatGPT Pro 5x 空白号档;日常轻量审查开通 ChatGPT Plus 会员 即可满足需求。

三、常见 Schema 报错与排错决策

--output-schema 与 --json 选型及排错

图:本站根据 OpenAI Structured Outputs 官方指南 整理的示意图

遇到命令报错或解析失败时(更多错误见 /guides/codex-common-errors-summary),按三点核查:

  1. 报 invalid_json_schema 400 错误:通常是嵌套对象漏写了 additionalProperties: false,或 properties 里的字段未全部放进 required。需要可空字段时,把类型设为 ['string', 'null'] 并保留在 required 中。
  2. 根节点写成了 array:结构化输出顶层必须是 object,返回列表时包一层 issues 属性即可。
  3. 输出文件混入进度日志:检查是否在 codex exec 右侧误加了 2>&1。保持默认分离才能让 stdout 只输出纯 JSON。
  4. 字段描述(description)写得含糊导致取值偏离预期:虽然 Schema 能锁死字段名和数据类型,但对于评分口径、严重等级划分标准等语义边界,建议在每个属性的 description 字段中用一两句中文写清判定依据(例如明确写出「仅当可导致线上崩溃、数据越权或资金计算错误时标为 high,代码风格建议一律标为 low」),能显著减少误报拦截。
  5. 超长差异导致响应缓慢或超时:当合并请求包含自动生成的锁文件(如 package-lock.json、pnpm-lock.yaml)或编译产物时,直接将全量 git diff 塞进管道会拖慢审查速度;上游命令可用路径排除语法(如 git diff origin/main...HEAD -- . ':(exclude)lock')提前过滤无关文件。

常见问题

问:--output-schema 支持所有 JSON Schema 校验语法吗?

答:它遵循 OpenAI Structured Outputs 支持子集,基础类型、enum 枚举、嵌套对象与数组均支持;若包含不受支持的关键字,接口会返回 400 并指出具体字段。

问:能不能用命令行参数直接指定输出文件路径?

答:可以。除标准输出重定向外,官方命令参考中 codex exec 也支持输出文件选项,具体参数名可运行 codex exec --help 核对当前 CLI 版本。

问:国内没有境外信用卡,或团队需要开增值税发票报销,怎么开通订阅?

答:可前往本站 AI 会员充值总览 选用 ChatGPT Plus 或 ChatGPT Pro,支持支付宝、微信支付及 AlipayHK 结算,提供卡密自助兑换(无需交出密码)与团队定制,支持开具增值税发票。实时价格以页面显示为准;售后遵循掉订阅按剩余天数折退、封号不在质保范围的规则。

相关教程

参考资料

  • OpenAI Codex 官方文档:Non-interactive mode — https://learn.chatgpt.com/docs/non-interactive-mode
  • OpenAI Codex 官方文档:Command line options — https://learn.chatgpt.com/docs/developer-commands
  • OpenAI API 官方文档:Structured Outputs — https://platform.openai.com/docs/guides/structured-outputs

Nathaniel 的更多内容

  1. 01

    独立开发者用 ChatGPT + Codex 跑通产品全流程:市场验证、PRD、原型到代码上线复盘清单

    单人做独立产品最容易陷入「闭门写两个月代码上线零用户」或「AI 写到一半目录越改越崩」。本文整理「ChatGPT 负责市场验证、PRD 与复盘 + Codex 负责工程实现与测试」的五阶段双轨流程,附起手提示词与 7 项上线复盘清单。

    ChatGPTCodex0
  2. 02

    用 ChatGPT 批量生成规范文件命名规则、整理混乱目录树与合并零散发票抬头清单脚本

    面对满桌面的「新建文件夹」「最终版2」和上百张零散电子发票,手工改名抄台账耗时又容易漏重。本文分享先脱敏取样、再用 ChatGPT 生成带预演和回滚日志的本地 Python 脚本,离线安全完成目录整理与发票抬头合并去重的实战流程。

    ChatGPT0
  3. 03

    用 ChatGPT 做海外邮件营销(EDM)受众分层文案、A/B 主题行测试与防进垃圾箱自检

    做海外独立站或出海 SaaS 邮件营销(EDM),最怕千人一面群发被直接送进垃圾箱。本文结合 Gmail/Yahoo 批量发件人规范,梳理用 ChatGPT 设计受众分层文案、批量生成 A/B 主题行矩阵并开展发前垃圾词与合规自检的实战提示词。

    ChatGPT0
  4. 04

    用 ChatGPT 写 Notion Formula 2.0 公式、Obsidian Dataview 查询与 Airtable 自动化脚本

    给 Notion 数据库写多条件 Formula 2.0 公式、给 Obsidian 写 Dataview 动态看板,或在 Airtable 里写自动化脚本,经常因为一个小括号或类型不匹配报错半天。本文整理三大工具的通用上下文喂料规范与三套直接可复制的生成提示词。

    ChatGPT其他 AI 工具0
  5. 05

    用 ChatGPT 处理复杂 JSON / YAML / XML 字段映射、格式转换与校验规则编写实战

    对接第三方 API、迁移 Kubernetes 配置或解析政企 XML 报文时,手工对照几百行嵌套字段既慢又容易漏掉空值与类型边界。本文整理用 ChatGPT 完成字段映射表梳理、生成确定性转换脚本以及编写 JSON Schema / Pydantic / XSD 校验规则的实战流。

    ChatGPT其他 AI 工具0
  6. 06

    用 ChatGPT 准备本科/硕士毕业论文答辩:提炼答辩 PPT 结构、模拟导师犀利追问与 3 分钟自述稿

    毕业论文写完后,要在 3–5 分钟内讲清研究价值并顶住答辩评委的连环追问并不轻松。本文整理在严格遵守高校学术规范的前提下,用 ChatGPT 提炼答辩 PPT 结构、打磨 3 分钟口语自述稿并开展模拟导师犀利追问的排练流程与提示词。

    ChatGPT0

同产品的其他教程

  1. 01

    用 ChatGPT 整理家庭装修预算明细、隐蔽工程验收清单与主材优缺点对比表实战

    第一次装修面对几十页施工报价单、密密麻麻的水电防水隐蔽项目与五花八门的主材参数,极易踩坑增项。本文梳理用 ChatGPT 审查装修报价漏项、生成带公式的预算明细表、定制工地隐蔽工程验收单与主材对比表的实战提示词。

    ChatGPT0
  2. 02

    用 ChatGPT 做费曼学习法读书共读:反向追问检验自己是否真读懂专业书籍与整理书单笔记

    读完一本专业硬书常感觉「合上书就忘」,直接让 AI 概括全书又容易产生懂了的错觉。本文介绍用 ChatGPT 结合 Study Mode 与费曼学习法做反向追问共读,通过通俗复述、挑刺盲区到沉淀书单卡片的完整流程与提示词。

    ChatGPT0
  3. 03

    用 ChatGPT 做外贸产品多语种目录、展会邀约与客户跟进节奏表(附脱敏与本地化提示词)

    做外贸展会与海外推广时,手工翻译十几款产品目录费时且容易留下一堆中式英文,展后客户跟进也常缺节奏。本文梳理用 ChatGPT 先脱敏建术语库、再批量产出多语种目录、展前邀约函与展后 21 天跟进节奏表的实战流程与提示词。

    ChatGPT0
  4. 04

    用 ChatGPT 写高质量技术专栏文章、开源项目 Release Notes 与版本更新日志实战

    让 AI 直接凭空写技术文章容易满篇空洞套话,直接甩 Git 记录写更新日志又常常漏掉破坏性变更。本文整理用 ChatGPT 结合真实代码片段、压测数据与 PR 摘要,高效产出深度技术专栏、GitHub Release Notes 与 CHANGELOG 的实战工作流。

    ChatGPT0
  5. 05

    用 ChatGPT 做产品用户访谈纪要编码、提炼高频痛点需求池与 RICE 优先级打分实战

    手头攒了十几份用户访谈逐字稿,手工贴便利贴归纳痛点耗时又容易带入主观偏见。本文分享用 ChatGPT 完成脱敏检查、逐份开放式编码、跨样本聚类高频痛点并搭建 RICE 优先级打分表的 5 步实战流,附可直接复制的三段核心提示词。

    ChatGPT0
  6. 06

    ChatGPT 网页版上传超过 10 个文件或回形针附件按钮变灰怎么办:打包合并与配额限制排查

    在 ChatGPT 网页版批量分析文档时,常遇到一次选超 10 个文件被拦截或输入框回形针按钮变灰。本文依据 OpenAI 文件上传与存储说明,梳理 6 类常见报错的分流排查法,提供 ZIP 打包、本地合并与 Projects 复用方案及可直接复制的解包提示词。

    ChatGPT0

0 条评论

登录 后参与评论

还没有评论,来抢沙发~