SuperAPI AI 工具集

repo-visual-overview

编程与开发

查看项目

更新于 10-26 07:56

技能介绍

用途

Repo visual overview 用于把一个代码仓库的工作方式绘制成一份可交互、以图表为主的 HTML 概览页面。页面由新启动的智能体生成,属于“只读呈现”:它描述仓库如何运作,但不给出 findings(发现/结论)。

主要能力

  • 生成一个自包含的 HTML 页面,包含 Architecture(架构)与 UI/UX 两个标签页。
  • 采用图表优先的呈现方式。
  • 页面不含 findings。
  • 该智能体只看到所给的仓库,不会接触当前会话。

使用方式

该技能仅在显式调用时运行,需要提供一个 GitHub 仓库,或一个本地目录路径。

运行流程:

  1. 询问由哪个模型、以何种推理强度来撰写概览。只提供当前运行时能够作为新智能体启动的模型,不设默认值。
  2. 在该模型上启动一个无历史记录的新智能体:在 Claude Code 中使用 Agent 工具并指定 general-purpose;在 Codex 中使用 spawn_agent 并设置 fork_turns: "none";在 T3 Code 中使用 delegate_task。
  3. 只向该智能体提供:仓库(用户给出的 GitHub URL 或 owner/repo,或本地文件夹的绝对路径;若用户未提供,则为当前 checkout)、references/writer-brief.md 的路径,以及由 node <skill-dir>/scripts/overviews.mjs path 打印出的输出文件夹。
  4. 回复页面路径。

相关文件:只有撰写者会读取这些文件。references/writer-brief.md 指向其余文件:references/diagram-types.md、assets/template.html 和 assets/marks.html。

清理旧概览

旧概览会一直保留,直到用户要求移除。清理步骤:

  1. 运行 node <skill-dir>/scripts/overviews.mjs clean --older-than <days> --dry-run。
  2. 展示列表。
  3. 用户确认后,去掉 --dry-run 再运行一次。

适用场景

适用于需要快速、直观地理解某个仓库整体架构与 UI/UX 组织方式的场景,尤其适合以图表形式向他人展示仓库如何运作。

限制

  • 仅在显式调用时运行。
  • 需要提供 GitHub 仓库或本地目录路径。
  • 必须选择运行时能够启动为新智能体的模型,且无默认模型。
  • 生成的页面不含 findings。
  • 具体支持哪些模型、推理强度选项以及各运行时的启动细节,资料中未完整给出,暂未提供。