Repolode
tanishqkancharla

tanishqkancharla/diffmap

一个智能体技能,让编码助手把代码改动以可交互图表的形式讲解,图中各部分链接到源码。

Star
238
Fork
9
未关闭 Issue
1
最近提交
昨天

这是什么?

diffmap 帮助开发者审阅编码智能体写出的代码。智能体会编写一份 Markdown 格式的说明文档,其中可以包含交互式 Mermaid 图、可逐步播放的动画服务图,以及图表和调用栈的差异对比。图中每个元素都能链接回对应的文件、符号或提交,审阅者可以从图中的方框或连线直接跳到背后的代码。

说明文档通过 npx 启动的本地查看器渲染,查看器内含 Diff 面板、可复制为 Markdown 列表的行内评论(方便交给智能体),以及按顺序列出待审文件的提交卡片。文档也可以作为未列出的 GitHub gist 分享,并在 diffmap.dev 上打开。项目基于 TypeScript,提供解析其 Markdown 格式的库接口。

核心功能

  • 01根据智能体编写的说明文档生成交互式 Mermaid 图和可播放的动画服务图。
  • 02展示图表和调用栈的差异,标出仅存在于当前版本或拟议版本中的部分。
  • 03将图中节点、调用栈行和正文中的引用链接到源文件、符号或提交。
  • 04提供带 Diff 面板的本地查看器,并支持行内评论,可复制后交给智能体。
  • 05可将说明文档以未列出的 GitHub gist 形式分享,并在 diffmap.dev 上查看。

适用场景

  • 在合并编码智能体生成的大型改动前进行审阅。
  • 向同事讲解功能分支中的请求流程或状态变化。
  • 在智能体的 diff 上留下逐行评论,并以编号列表形式交还给智能体。
  • 通过链接与团队分享便于审阅的 Pull Request 讲解。

快速上手

  1. 1

    在有改动的仓库中,把 diffmap 提示词粘贴给你的智能体来试用

  2. 2

    安装 generate-diffmap 技能

    npx skills add tanishqkancharla/diffmap --skill generate-diffmap
  3. 3

    在规格文件上运行本地查看器

    npx @tanishqkancharla/diffmap serve path/to/file.md

使用前须知

  • 以链接形式分享规格文件仍处于实验阶段,需要已登录的 gh CLI。
  • 托管在 Gist 上的查看器会在浏览器中从 api.github.com 获取 Gist。

收录于专题

标签

常见问题

diffmap 是什么?
一个智能体技能,让编码助手把代码改动以可交互图表的形式讲解,图中各部分链接到源码。 diffmap 帮助开发者审阅编码智能体写出的代码。智能体会编写一份 Markdown 格式的说明文档,其中可以包含交互式 Mermaid 图、可逐步播放的动画服务图,以及图表和调用栈的差异对比。图中每个元素都能链接回对应的文件、符号或提交,审阅者可以从图中的方框或连线直接跳到背后的代码。
diffmap 可以免费使用吗?用的什么许可证?
diffmap 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
diffmap 还在维护吗?
活跃维护中。diffmap 最近一次提交是在 2026年11月6日。
diffmap 适合用来做什么?
在合并编码智能体生成的大型改动前进行审阅。 向同事讲解功能分支中的请求流程或状态变化。 在智能体的 diff 上留下逐行评论,并以编号列表形式交还给智能体。 通过链接与团队分享便于审阅的 Pull Request 讲解。
diffmap 怎么安装和运行?
在有改动的仓库中,把 diffmap 提示词粘贴给你的智能体来试用 安装 generate-diffmap 技能: npx skills add tanishqkancharla/diffmap --skill generate-diffmap 在规格文件上运行本地查看器: npx @tanishqkancharla/diffmap serve path/to/file.md
在哪里获取 diffmap?
源代码和安装说明在 GitHub 上:https://github.com/tanishqkancharla/diffmap

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目