该技能面向需要让编码智能体可靠调用命令行工具的场景,提供一整套 CLI 设计或审查原则。
用途 人类导向的 CLI 常在智能体场景下失效:交互式提示、庞大的前置文档、没有可直接复制示例的帮助文本都会阻塞自动化。此技能主张采用无头运行、可在管道中组合的设计模式。
主要能力
- 非交互优先:每个输入都应能以标志或标志值表达;不要求方向键、菜单或定时提示。若标志缺失,应回退到交互模式,而不是反过来。示例:不推荐 mycli deploy 后弹出“选择环境(用方向键)”,推荐 mycli deploy --env staging。
- 不倾倒上下文的可发现性:智能体应能增量发现子命令,先运行 mycli,再运行 mycli deploy --help;不要每次运行都打印整本手册。每个子命令自带文档,未使用的命令不进入上下文。
- 可用的 --help:每个子命令都有 --help,且每个 --help 都包含带真实调用的“示例”段,示例比散文更利于模式匹配。
- stdin、标志与管道:合理接受 stdin(如 cat config.json | mycli config import --stdin);避免奇怪的位置参数顺序,避免在缺失值时回退到交互提示;支持链式调用,如 mycli deploy --env staging --tag $(mycli build --output tag-only)。
- 快速失败并给出可操作错误:缺失必需标志时立即退出,给出清晰信息与正确示例调用,而不是挂起。
- 幂等性:智能体经常重试,同一成功命令重复运行应安全(无操作或明确提示“已完成”),不产生重复副作用。
- 破坏性操作:提供 --dry-run 或等价选项供智能体预览计划;提供 --yes/--force 跳过确认,同时为人类保留安全默认值。
- 可预测结构:处处使用一致模式,如 resource + verb;若存在 mycli service list,则 mycli deploy list 与 mycli config list 应遵循同样形态。
- 成功输出:成功时返回机器可用数据(ID、URL、耗时),纯文本即可,避免只依赖装饰性输出。
使用方式 可作为设计新 CLI 的规范,或作为审查现有 CLI 的检查清单。
审查现有 CLI 时检查项 非交互路径、分层帮助、--help 上的示例、stdin/管道方案、带调用示例的错误消息、幂等性、dry-run、确认绕过标志、一致的命令结构、结构化成功输出。
适用场景 为编码智能体或自动化流水线编写、改造、评审命令行工具时。
限制 资料未提供具体价格、平台支持范围或安装命令;实际效果与适用性暂未提供。