arch-diagram-skill

skill
Guvenlik Denetimi
Basarisiz
Health Gecti
  • License — License: MIT
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Community trust — 49 GitHub stars
Code Basarisiz
  • spawnSync — Synchronous process spawning in bin/cli.mjs
  • process.env — Environment variable access in bin/cli.mjs
  • exec() — Shell command execution in skills/arch-diagram/assets/engine.js
Permissions Gecti
  • Permissions — No dangerous permissions requested

Bu listing icin henuz AI raporu yok.

SUMMARY

RokoAI arch-diagram: a Claude Code & Codex skill that turns any repo or article into an animated architecture diagram (HTML / PNG / MP4 / GIF / Mermaid) with a live trace log

README.md

简体中文 · English · Español · 日本語 · 한국어 · ไทย

RokoAI arch-diagram 架构图 Skill

适用于 Claude Code 和 Codex。

给它一个 GitHub 仓库、一篇技术文章、一份 PDF 或本地项目,Claude Code 或 Codex 会读懂结构,画出一张深色"终端蓝图"风格的架构图。连线上有流动的光点,底部的 log 会在模块之间交换数据时实时加一行。

下面是开源项目 morluto/rea 的架构图,由这个 Skill 读取它的 GitHub 仓库自动生成:

morluto/rea 架构图

更多例子(文章、GitHub 仓库、需求文档)见文末的 示例。

能做什么

  • 按内容选结构:分层系统、流水线、带循环的流程、中心辐射、泳道、层级树,不套固定模板。
  • 颜色有含义:元素按种类上色;连线按流向类型(请求、写入、回传、异步……)区分颜色和虚实;分组框表示包含关系。
  • 实时 trace log:光点到达终点时,底部追加一行 时间 · 类型 · A → B · 说明。
  • 自检:用无头 Chrome 检查元素重叠、文字溢出、连线穿过方框、标签被遮挡,有问题就改到干净为止。
  • 多种输出:
    • 可交互的单文件 HTML
    • PNG(2 倍分辨率)
    • MP4:默认 20 秒,可指定任意秒数,4 秒一个周期无缝循环
    • GIF:一个周期
    • Mermaid 流程图

图的语言跟着提示词走

用什么语言提要求,图就是什么语言:

  • 用中文写提示词,图里的标题、说明、标签、log 都是中文
  • 用英文写,整张图就是英文
  • 用日语写,内容就都是日文

即使原文或源码是另一种语言也一样。代码里的标识符、路径、命令保持原样。图例、状态标签等界面文字内置了中文、英语、日语、韩语、西班牙语、泰语;其他语言由 Claude 按你的语言写出来。

安装

需要 Node ≥ 18 和 Chrome、Chromium 或 Edge。输出视频和 GIF 还需要 ffmpeg(brew install ffmpeg)。

方式一:npm(最简单)

npx @rokoai/arch-diagram install

会装到 ~/.claude/skills/arch-diagram。加 --project 则装到当前项目的 .claude/skills/。更新时再跑一次;卸载用 npx @rokoai/arch-diagram uninstall。

装了 Codex 的话(存在 ~/.codex),会同时装到 ~/.codex/skills/arch-diagram。只装其中一个,可以加 --claude 或 --codex。

在本仓库的 clone 目录里运行 npx @rokoai/arch-diagram … 会报 arch-diagram: command not found:npm 会把当前目录当成这个包本身,不会把它的命令加进 PATH。请到仓库外的目录运行,或在仓库里直接用 node bin/cli.mjs install(参数相同,如 --codex)。

方式二:插件。Claude Code 里依次执行:

/plugin marketplace add bassnova42/arch-diagram-skill
/plugin install arch-diagram@arch-diagram

Codex CLI 里:

codex plugin marketplace add bassnova42/arch-diagram-skill
codex plugin add arch-diagram@arch-diagram

方式三:手动拷贝

git clone https://github.com/bassnova42/arch-diagram-skill
cp -R arch-diagram-skill/skills/arch-diagram ~/.claude/skills/
cp -R arch-diagram-skill/skills/arch-diagram ~/.codex/skills/   # Codex

装好后重启 Claude Code 或 Codex。

用法

在 Claude Code 或 Codex 里直接说,比如:

  • 把 https://github.com/plausible/analytics 画成架构图
  • 这篇文章画成流程图:<URL>,输出成视频,30 秒
  • 把刚才的图输出成图片 / 输出成 mermaid
  • 想明确指定用这个 Skill:Claude Code 里输入 /arch-diagram <仓库或文章地址>,Codex 里输入 $arch-diagram <仓库或文章地址>

图的源文件是 <slug>.spec.json,要修改就让 Claude Code 或 Codex 改 spec,再重新生成。也可以用命令行直接操作:

npx @rokoai/arch-diagram build  my.spec.json my.html
npx @rokoai/arch-diagram check  my.html
npx @rokoai/arch-diagram export my.html my.png my.mp4 --seconds 30

目录

skills/arch-diagram/
  SKILL.md            工作流程:读源 → 选结构 → 布局 → 自检 → 导出
  assets/             渲染引擎、样式、模板
  scripts/            build / check / export
  references/         spec 字段说明、视觉风格
  examples/           rea(仓库)、plausible(仓库)、elephant-goldfish(文章)
bin/cli.mjs           npm 命令:install / uninstall / build / check / export

示例

1. 对一篇文章做的架构图

来源:Dave Rensin 的文章《Elephants, Goldfish, and the New Golden Age of Software Engineering》
https://drensin.medium.com/elephants-goldfish-and-the-new-golden-age-of-software-engineering-c33641a48874

对一篇文章做的架构图

▶ 完整视频(MP4,30 秒)

2. 对一个 GitHub 仓库做的架构图

来源:https://github.com/morluto/rea

对一个 GitHub 仓库做的架构图

▶ 完整视频(MP4,20 秒)

3. 对一份需求文档做的架构图

来源:Ballet 芭蕾动作评分小程序的需求文档(PRD)和代码。这是私有项目,没有公开链接。

对一份需求文档做的架构图

▶ 完整视频(MP4,20 秒)

License

MIT

Yorumlar (0)

Sonuc bulunamadi