SuperAPI AI 工具集

cli-for-agents

编程与开发

查看项目

更新于 11-19 03:05

技能介绍

用途 cli-for-agents 面向为编码智能体设计或评审命令行界面的场景。其核心问题在于:面向人类的 CLI 常用交互式提示、巨大的前置文档、没有可复制示例的帮助文本,导致智能体难以可靠运行。

主要能力与设计要点

  1. 非交互优先:每个输入都应能通过标志或标志值表达,不要求箭头键、菜单或定时提示;缺少标志时才回退到交互模式,而不是反过来。资料给出的反例是 mycli deploy 弹出选择环境菜单,正例是 mycli deploy --env staging。
  2. 分层可发现性:智能体逐步发现子命令,先运行 mycli,再运行 mycli deploy --help;不应每次运行都打印完整手册,让每个子命令自述文档,使未使用命令不进入上下文。
  3. 可用的 --help:每个子命令都有 --help,且包含真实调用示例;示例比纯文字更利于模式匹配。资料示例中列出 --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. 可预测结构:全局采用一致模式,如资源+动词;若存在 mycli service list,则 mycli deploy list 与 mycli config list 应保持相同形状。
  9. 成功输出:成功时返回机器可用数据,如 ID、URL、耗时;纯文本即可,避免仅依赖装饰性输出。资料示例返回部署版本、URL、deploy_id 和 duration。

使用方式 资料未提供具体安装命令或代码接口,仅给出设计原则与评审清单。评审现有 CLI 时可按以下项检查:非交互路径、分层帮助、--help 中的示例、stdin/管道方案、带调用示例的错误信息、幂等性、dry-run、确认绕过标志、一致的命令结构、结构化成功输出。

适用场景 适用于需要让编码智能体自动调用命令行工具的团队,包括部署、配置导入、构建等操作;也可用于审查已有 CLI 是否适合智能体使用。

限制 资料仅为规范与示例,未说明具体实现语言、安装方式、运行平台或收费信息;相关事实暂未提供。