SuperAPI AI 工具集

writing-cli-skills

写作与研究

查看项目

更新于 10-15 23:41

技能介绍

用途:指导如何为命令行工具编写 agent skill(智能体技能),让智能体在合适时机加载并正确使用某个 CLI 工具。

主要能力与要点:

  1. 先动手再写文档。安装工具并实际试用,对每个子命令运行 --help,亲自尝试常见操作,记录意外或不明显的行为。若工具不可用,可用 WebFetch 查阅官方文档与 man 手册,但需在技能中标注“未经动手验证”。
  2. 创建技能:复制 references/template.md 到新技能目录,按实际经验填写章节,删除不适用部分。不同宿主安装方式不同,例如 Claude Code 用 ln -s "$PWD/skills/my-tool" ~/.claude/skills/my-tool,OpenCode 用 ln -s "$PWD/skills/my-tool" ~/.config/opencode/skills/my-tool,Clawdbot 用 ln -s "$PWD/skills/my-tool" ~/clawd/skills/my-tool。
  3. 必需章节:Frontmatter(name、带触发词的 description)、Installation(如何获取二进制)、Usage(覆盖 80% 用例)。推荐章节:Requirements、Quick Start、Output Formats、Tips & Gotchas、Troubleshooting、Configuration、Uninstall、References,按工具情况选用。
  4. 描述要含触发短语,例如“Monitor RSS feeds for updates. Use when tracking blogs…”,而非仅写“RSS tool.”。命令按任务分组(查看/列表、创建/添加、编辑/更新、删除/移除、搜索),而非按命令名。
  5. 渐进式披露:SKILL.md 控制在约 500 行以内,细节移到 references/ 与 scripts/。

禁止事项:不要逐字粘贴 --help 输出;不要记录每个 flag;不要包含未测试的命令;不要超过 500 行。

发布前检查清单:frontmatter 含 name 与带触发词的 description;安装覆盖目标平台;含验证命令(tool --version);记录配置文件位置与必需环境变量;用法覆盖 80% 常见操作;示例含真实用法与样例输出;记录输出格式;故障排查含调试模式;卸载能清理配置与数据;总行数低于 500。

限制:资料未提供具体工具示例、价格或平台支持范围等细节。