用途:为编码智能体设计或审查 CLI,使工具能在无人值守、可管道组合的场景中稳定运行。人向 CLI 常有交互式提示、庞大前置文档和无示例帮助文本,会阻塞智能体,此指南给出替代模式。
主要能力与建议: 非交互优先:每个输入都应能通过 flag 表达,不依赖方向键、菜单或计时提示;缺 flag 时再回退到交互模式,而非相反。示例:mycli deploy --env staging。 渐进式发现:智能体逐层探索,先 mycli,再 mycli deploy --help,不应每次运行都打印整本手册;各子命令自持文档。 可用的 --help:每个子命令都有 --help,且包含真实调用示例(示例比散文更利于模式匹配)。 stdin 与管道:在合理处接受 stdin,如 cat config.json | mycli config import --stdin;避免古怪的位置参数顺序,缺值时不要回退交互提示;支持链式调用。 快速失败的报错:缺少必需 flag 时立即退出并给出清晰信息与正确示例调用,而非挂起。 幂等性:同一成功命令重复执行应安全(无操作或明确“已完成”),不产生重复副作用。 破坏性操作:提供 --dry-run 预览计划,提供 --yes / --force 跳过确认,同时保留对人的安全默认值。 结构可预测:统一“资源+动词”模式,如 mycli service list 存在时,deploy list、config list 应同形。 成功输出:返回机器可用的 ID、URL、耗时等,纯文本即可,别只依赖装饰性输出。
审查已有 CLI 时检查:非交互路径、分层帮助、--help 中的示例、stdin/管道方案、含调用的报错信息、幂等性、dry-run、跳过确认的 flag、命令结构一致性、结构化成功输出。
限制:资料未提供具体平台、安装方式、收费与版本信息。