用途:cli-design 面向设计、构建或审查命令行界面(CLI)工具的场景,提供一份标准 CLI 约定检查清单,帮助开发者逐项核对实现是否符合惯例。不适用于非 CLI 相关任务。
主要能力(检查项): 帮助与版本:CLI 必须提供 --help 与 -h,包含清晰用法、选项和示例,示例须覆盖所有必需参数;必须提供 --version 与 -V,并保留 -v 给 --verbose。 输入输出:必须支持 stdin/stdout 管道,并允许输出重定向(如 --output 写文件);输出结构化数据时必须提供机器可读格式(如 --json)。 安全与控制:会修改或删除数据的 CLI 必须提供 --dry-run 和显式绕过标志(--yes 或 --force);必须提供可控日志(--quiet、--verbose 或 --trace);必须使用确定性退出码,0 表示成功、非零表示失败,不得引入静默回退;必须实现严格非交互模式以适配 CI/CD。 配置:消费 JSON 配置的 CLI 必须定义并更新 JSON Schema,并在加载时校验配置;敏感或环境相关数据必须支持通过环境变量配置。 交互提示:交互式提示在提问前必须提供必要上下文;是/否提示中回车必须表示“是”,n 必须表示“否”。
使用方式:将上述条目作为设计或审查清单逐项核对 CLI 实现。资料未提供具体安装命令、代码示例或调用方式。
适用场景:CLI 工具的设计、开发与代码审查,尤其是需要兼顾自动化与 CI/CD 的场景。
限制:资料仅给出约定清单,未说明具体实现语言、平台、收费或效果;非 CLI 场景不适用。