SuperAPI AI 工具集

cli-for-agents

智能体与模型

查看项目

更新于 10-16 09:51

技能介绍

用途:该技能关注如何设计或审查 CLI,使其能被编码智能体可靠地以无头方式运行,避免仅为人类设计而阻塞智能体的交互提示、冗长文档和缺乏示例的帮助文本。

主要能力与要求:

  1. 非交互优先:每个输入都应能用标志或标志值表达,不依赖方向键、菜单或定时提示;标志缺失时再回退交互模式。例如使用 mycli deploy --env staging,而非先弹菜单选择环境。
  2. 渐进式发现:智能体按需逐层发现命令,如先 mycli,再 mycli deploy --help,不要在每次运行时打印整本手册;每个子命令自带文档,未用到的命令不进入上下文。
  3. 可用的 --help:每个子命令都有 --help,并包含带真实调用的 Examples,便于模式匹配,优于纯文字说明。资料给出了选项与示例的展示形式,包括 --env、--tag、--force 等。
  4. stdin 与管道:在合适处接受 stdin(如 cat config.json | mycli config import --stdin),避免奇怪的位置参数顺序,避免缺值时回退交互提示;支持链式调用,例如 mycli deploy --env staging --tag $(mycli build --output tag-only)。
  5. 快速失败与可操作错误:缺少必需标志时立即退出,给出清晰信息和正确的示例调用,而不是挂起。资料中给出无镜像标签时的错误示例及可用标签查询方式。
  6. 幂等性:智能体常重试,同一成功命令重复运行应安全(无操作或明确提示已完成),不产生重复副作用。
  7. 破坏性操作:提供 --dry-run(或等效方式)供预览;提供 --yes / --force 跳过确认,同时保留对人类的安全默认值。
  8. 结构可预测:采用一致模式,如资源加动词,使 service list、deploy list、config list 保持同构。
  9. 成功输出:返回机器可用数据,如 ID、URL、耗时;纯文本即可,避免仅依赖装饰性输出。资料给出了部署成功后的示例输出,包含版本、url、deploy_id、duration。

审查现有 CLI 时需检查:非交互路径、分层帮助、--help 上的示例、stdin/管道支持、带调用示例的错误信息、幂等性、dry-run、确认绕过标志、一致的命令结构、结构化成功输出。

限制:资料未提供具体的安装命令、代码实现、支持的平台或收费信息,暂未提供。该技能本身为设计/审查规范,不包含可执行代码。