Visual Explainer:从终端艺术到 HTML 图表

Visual Explainer: 从终端艺术到 HTML 图表

介绍

许多开发者仍将复杂的终端输出打印成纯文本,但 ASCII 艺术和管道分隔表格很快变得难以阅读。Visual Explainer 能将任何终端图表、代码差异或计划审查转换成精美、全自包含的 HTML 页面——包括深色/浅色主题、交互式 Mermaid 图表和响应式幻灯片集。

问题

  • 终端 ASCII 艺术适用于单容器流程图,但在多容器图表中失效。
  • 使用 |- 渲染的表格在终端中看起来很棒,但导出或共享时会崩溃或换行不良。
  • 从原始差异输出准备演示文稿或文档既耗时又易出错。

解决方案

Visual Explainer 用浏览器友好的页面替代杂乱的终端输出,保持结构、样式和交互性。它附带若干方便的斜杠命令,能自动识别您正在导出的复杂数据并渲染最佳的 HTML 表示。

核心功能

功能 描述
/diff-review 生成视觉差异审查,包含之前/之后的架构图、KPI 仪表盘,以及结构化的优/劣/丑代码评审。
/plan-review 将计划文件与代码库交叉引用,标记风险,并生成当前与计划架构图。
/generate-web-diagram 将任何图表主题转换为独立的 HTML 页面,例如 “绘制我们的身份验证流程图”。
/generate-slides 将提示转换为具有期刊质量的幻灯片集,支持可选的 --slides 标志。
/project-recap 捕捉项目近期活动的快照,展示架构、决策日志和认知债务热点。
/fact-check 验证文档中的声明与实际代码。

所有命令都触发同一个底层工作流程:该功能会解析您的请求,挑选合适的参考模板,从 references/ 文件夹获取所需数据,并在 ~/.agent/diagrams/ 写入一个 HTML 文件。页面会自动在您默认的浏览器中打开。

安装

如果您已是 pi 用户,安装只需一行:

pi install https://github.com/nicobailon/visual-explainer

对 Claude Code 或其他代理用户,只需克隆到技能目录:

git clone https://github.com/nicobailon/visual-explainer.git ~/.claude/skills/visual-explainer

无需构建步骤;该工具仅依赖浏览器,并可选择使用 surf-cli 二进制文件生成图片。

使用该功能

快速演示:

generate-web-diagram
draw a diagram of our authentication flow

该功能将渲染 Mermaid 图表,应用浅色/深色主题,并在浏览器中打开文件 ~/.agent/diagrams/auth-flow.html

要审查最近的拉取请求:

diff-review #42

默认情况下,/diff-review 比较当前分支与 main。您也可以传递任意引用:

diff-review abc123            # single commit
diff-review main..HEAD         # all staged commits
diff-review main..dev-feature # entire branch

要从差异审查创建幻灯片集,请添加 --slides 标志:

diff-review --slides

自定义

  • 主题与布局 – 在 references/css-patterns.md 中编辑 CSS 文件,选择配色方案或调整动画。
  • 模板 – 替换 templates/ 中任意四个模板(如 architecture.htmldata-table.html),或自行编写。
  • 输出目录与浏览器 – 修改 SKILL.md 中的变量,以更改文件写入位置或启动方式。

由于该功能每次运行都会重新加载模板,您可以快速迭代,无需重新启动代理。

限制与权衡

  • 不支持终端内联渲染 – 结果在浏览器中打开;无法在终端内查看。
  • 主题切换需要刷新页面 – Mermaid SVG 不能自动适应系统主题更改。
  • 基于模型的质量 – 可视化结果取决于基础 LLM 生成 Mermaid 或 CSS 代码的能力。

尽管存在这些限制,Visual Explainer 显著降低了将原始文本转换为有意义可视化成果的摩擦。

社区与支持

该仓库得到积极维护,并定期更新诸如 anti‑slop 保护(v0.3.0)等功能。欢迎在 GitHub 上提出问题、功能请求和拉取请求。3.3k 颗星标记着越来越多的开发者将此工具用于从应急图表到正式文档的各种需求。

结论

Visual Explainer 是一款轻量级、开源的开发者工具,可将嘈杂的终端输出转换为精美的 HTML 页面或幻灯片集。通过几条斜杠命令,您可以自动生成架构图、差异审查、计划审核或演示文稿——全部在代理环境内完成。立即尝试,让代码库呈现应得的视觉清晰度。

原创文章: 查看原文

分享本文