给命令行工具加机器可读输出
收录 2026-11-06
给人看的输出和给程序用的输出，应该分开。
我有一个命令行工具：[工具用途、现有输出、使用者]。请帮我加机器可读输出：1）设计 `--json` 模式的 schema（成功、失败、部分成功分别长什么样）；2）说明如何与人类可读输出共存而不破坏现有脚本；3）定义退出码与错误对象，保证脚本能区分失败类型；4）处理分页/流式结果与超大输出的方式；5）给出「输出稳定」的承诺范围（哪些字段可能变、如何标注实验性）；6）列出要补的测试与文档，以及一个迁移示例。
本站原创
中文原文
复制前替换这些占位符 1
把方括号里的内容换成你的具体信息，替换后再粘贴给 AI。
[工具用途、现有输出、使用者]
使用建议
先定 JSON 与退出码，再补人类可读的漂亮输出。
可以这样改
- 要求它先复述需求与约束，确认无误再写代码。
- 让它给出最小改动 + 回滚方式，而不是整文件重写。
交付物（这次应拿到什么）
- 可运行的最小改动（含直接可用的代码块）
- 影响面清单：改了哪些文件、哪些调用点要跟着改
常见错法
- 一次让它改十个文件，最后分不清哪处改动导致了新问题。
- 只贴报错不贴代码和版本，拿到无法落地的修法。
输出验收（怎么判断能用）
- 改动可运行、可回滚，且没顺手改无关代码。
- 边界条件（空值、超长、并发）有说明或测试。
适用场景与注意
- 适合：让它先复述需求和约束，再给最小可运行改动。
- 注意：贴报错时同时给版本号与最小复现，否则它容易给出看似合理但不适配的写法。