用途:为构建和审计命令行工具提供专家级规则,核心论点是 CLI 有三类用户——TTY 前的人、CI 中的脚本、驱动该工具的 AI 智能体,每个设计决策都要同时服务这三者。
主要能力:分 BUILD 与 AUDIT 两种模式。BUILD 模式建议先写 --help 再写代码,默认值覆盖常见路径,从第一天就分离 stdout 与 stderr(主输出→stdout,日志/进度/提示/错误→stderr),默认管道安全(TTY 检测、管道时禁用颜色/进度/提示、尊重 NO_COLOR、v0.1 起每个列表/读取命令都提供 --json),把退出码、flag、环境变量和 JSON 结构视为公开 API,构建 Ctrl-C 清理、--dry-run、可重入操作。AUDIT 模式先定位解析器、入口、输出与错误路径、信号处理器,再运行最小探测集(--help、--version、未知命令、tool list | cat、tool list | head -1、重定向到 /dev/null、stdin 关闭、echo $?、中途 Ctrl-C),并核查配置优先级、密钥处理、临时/状态文件位置与更新/遥测行为。
严重度:Critical(无确认的破坏性操作、退出码撒谎、stdin 关闭时挂起、密钥泄漏、未披露的自动更新或遥测);High(stdout 被 ANSI/日志污染、无 --json、SIGINT 留下损坏状态、退出码冲突);Medium(缺少长格式、缺少进度、错误无补救、$HOME 点文件、无补全);Low(无示例、无拼写建议、无 man page)。发现格式含 Where/Rule/Issue/Impact/Fix。
规则索引:01 命令与参数配置、02 输出与交互、03 行为与生命周期、04 分发与文档。
限制:原文未提供具体价格、平台或安装命令;以上为规范指引,不构成对任何工具的功能保证。