CLI 设计检查清单
帮助与版本
- CLI 必须提供
--help和-h标志，并附带清晰的使用说明、选项和示例。示例必须包含所有必需的参数。 - CLI 必须提供
--version和-V标志。Agent 必须保留-v用于--verbose。
输入与输出
- CLI 必须支持 stdin/stdout 管道，并且必须允许输出重定向（例如，使用
--output创建文件）。 - 输出结构化数据的 CLI 必须提供机器可读的输出（例如，
--json）。
安全与控制
- 修改或删除数据的 CLI 必须提供
--dry-run标志，以及一个明确的绕过标志（--yes或--force）。 - CLI 必须提供可控的日志（
--quiet、--verbose或--trace）。 - CLI 必须使用确定的退出码：0 表示成功，非零表示失败。Agent 不得引入静默回退。
- CLI 必须实现严格的非交互模式，以便在 CI/CD 环境中使用。
配置
- 消费 JSON 配置的 CLI 必须定义并更新 JSON Schema，并且必须在加载时验证配置。
- CLI 必须支持通过环境变量配置敏感数据或与环境相关的数据。
交互式提示
- 交互式提示在提问前必须提供所需的上下文。对于是/否提示，Enter 必须表示“是”，“n”必须表示“否”。