SuperAPI AI 工具集

readme-updater

写作与研究

查看项目

更新于 10-16 07:51

技能介绍

用途

README Updater 用于更新仓库根目录的 README.md,使其反映仓库中所有 agent 公司(company)的最新状态。当新增公司、公司详情发生变化,或需要让 README 与目录结构保持一致时使用。

主要能力

  • 发现公司:列出所有包含 COMPANY.md 的顶层目录,跳过 default/、skills/ 以及点文件目录。
  • 收集数据:从 COMPANY.md 的 YAML frontmatter 获取名称,从正文首段获取描述,从底部 “Generated from name” 行提取上游来源名称与 URL;统计 agents/ 下的子目录数量,统计 skills/*/SKILL.md 文件数量。
  • 生成组织架构图:对尚未拥有 images/org-chart.png 的公司,运行 ~/paperclip scripts/generate-company-assets.ts <company-directory> 生成图片;若图片已存在且公司未变化则跳过,用户明确要求重新生成时再运行。
  • 写入 README:替换 README.md 中的 ## Companies 章节,保留 ## Structure、## Shared Skills、## Usage 等其他章节不变。
  • 生成索引表:在 ## Companies 标题前加入汇总索引表,包含 Company、Agents、Skills、Source 四列。
  • 校验:写入后回读 README,确认每个含 COMPANY.md 的目录都有条目、已删除目录没有残留条目、图片路径指向存在的文件、agent 与 skill 数量与实际目录内容一致。

使用方式

该技能以工作流形式执行:先发现公司,再逐个收集数据,按需生成组织架构图,然后按固定格式写入 README,最后进行校验。

公司条目必须遵循以下格式:

Company Name

npx companies.sh add paperclipai/companies/<directory-name>

<来自 COMPANY.md 正文的一句话描述,最多一到两句。> Built from upstream name.

Agents (N): Agent One, Agent Two, Agent Three(最多 25 个,超出显示 “and N more”)

Skills (N): skill-one, skill-two, skill-three(最多 25 个,超出显示 “and N more”)

规则包括:标题链接到公司目录;描述为简要摘要而非完整正文;上游来源链接来自 COMPANY.md 的 “Generated from” 行,自然追加到描述句末;组织架构图路径固定为 ./<dir>/images/org-chart.png;agent 名称将连字符替换为空格并转为标题大小写;skill 名称保持连字符形式(即目录名);agent 与 skill 数量写在标签后的括号中;若公司没有 skills 目录或没有 skills,则省略 Skills 行。

索引表格式:

Company Agents Skills Source
Company Name N N source

Company 列链接到标题锚点(小写、空格转连字符);Skills 列在公司无 skills 时显示 —;表格顺序与下方公司条目顺序一致。

排序规则:前三家公司固定为 GStack、Superpowers Dev Shop、Agency Agents,顺序不变;其余公司按目录名字母顺序排列;若包含 default,则放在最后。

命名覆盖:agency-agents 目录显示为 Agency Agents(而非 “The Agency”)。

适用场景

  • 仓库新增了一个 agent 公司目录,需要同步 README。
  • 已有公司的名称、描述、上游来源、agents 或 skills 发生变化。
  • 需要为缺少组织架构图的公司生成图片。
  • 需要确保 README 中的公司列表、索引表、图片路径和数量统计与实际目录结构一致。

限制

  • 仅处理包含 COMPANY.md 的顶层目录,跳过 default/、skills/ 和点文件目录。
  • 只替换 README.md 的 ## Companies 章节,其他章节保持不变。
  • 组织架构图生成依赖 ~/paperclip scripts/generate-company-assets.ts 脚本,资料未提供该脚本的安装或环境要求。
  • 资料未提供该技能的安装方式、收费模式、平台支持或运行环境要求。