SuperAPI AI 工具集

visualize-repo

写作与研究

查看项目

更新于 10-15 20:09

技能介绍

用途:在仓库中建立受源码控制的可视化文档层,用于长期理解仓库结构,而非一次性的临时计划。组件可配线框图,API 可配规范说明,模型可配结构视图,评审者可在文档上评论后再交给编码智能体。

主要能力:默认从仓库根目录运行 npx @agent-native/core@latest visualize-repo --open,会写入或更新 agent-native.json 的 apps.visualize-repo 本地文件段,在 .agent-native/visual-docs/repo-overview 生成起始 MDX 目录,并通过本地桥接服务提供访问。可用变体包括 init、check、verify、--no-open,以及用 --target 指定目标文件,例如 npx @agent-native/core@latest visualize-repo --target actions --target server/db/schema.ts。若不存在清单文件,CLI 会自行引导创建,扫描 actions/、app/components/、app/pages/、server/db/schema.ts、src/、packages/、templates/、docs/、content/ 等起点。

使用方式:先检查 agent-native.json 与生成的 plan.mdx,阅读每个目标的源码锚点后再改动可视化文档;只添加有价值的可视化块,如 api-endpoint、data-model、wireframe、diagram、annotated-code。编辑 MDX 后运行 check,交接前可用 verify。处理评论时,以本地 comments.json 作为反馈收件箱,智能体相关评论应转化为代码改动并同步更新 MDX。

限制与隐私:check 为本地离线检查;--open 启动 localhost 桥接并打开 Plan UI,基于本地文件,不发布到托管存储,也不做托管数据库写入。verify 可能将 MDX 目录发送到 Plan 应用的公开校验动作以检查渲染结构;若不想外发内容,可传 --app-url 指向本地 Plan 应用,或跳过 verify 只用 check。除非用户明确要求发布或分享,不要调用托管的 Plan 写入工具(如 create-visual-plan、update-visual-plan 等),直接编辑 MDX 文件并使用本地桥接。