一个指令把代码库变成结构化Wiki!Claude Code党必装
Nium-Wiki:一个指令,把整个代码库变成结构化Wiki
刚接手一个几千行的老项目,是不是最怕的就是看不懂?文件关系乱、注释少、交接文档早就不知道去哪了。以前只能一行行读代码硬啃,现在有了一个叫 Nium-Wiki 的 Claude Code Skill,丢给它一句「generate wiki」,它就能把整个代码库自动编译成一套带架构图、依赖关系和交叉引用的专业文档。
这大概是 Karpathy 那个 LLM Wiki 思路在工程实践中跑得最顺的一个实现。
它做了什么?
分析 → 生成 → 增量更新,一条命令搞定。
输入 generate wiki 之后,Nium-Wiki 会自动跑完这个流程:
- 深度代码解析 — 不是简单正则匹配,而是语义理解代码结构
- 生成 Mermaid 架构图 — 数据流、模块依赖一目了然
- 双向链接文档 — 文档和源码互相可跳转,有溯源
- 自动质量审计 — 输出企业级文档标准
最实用的是增量更新:代码改了,只需要跑 update wiki,它会用 SHA256 差分 + 依赖图传播,只重写受影响的页面,其他文档原封不动。
为什么适合 Claude Code?
Claude Code 本身擅长读代码,但输出格式不固定、不成体系。Nium-Wiki 作为 Skill 加载进去之后,直接给它一个明确指令,它就按固定范式生成文档——变成了一个有纪律的代码文档助手,而不是每次对话都在重新发明格式。
生成的文档结构是这样的:
.nium-wiki/
├── config.json # 语言和排除设置
├── meta.json # 版本、统计
├── cache/
│ ├── structure.json # 项目结构快照
│ ├── source-index.json # SHA256 文件哈希(变更检测)
│ ├── dep-graph.json # 依赖图
│ └── facts/ # 按模块的事实提取缓存
└── wiki/
├── index.md # 项目首页
├── architecture.md # 系统架构 + Mermaid 图
├── getting-started.md # 快速上手
├── doc-map.md # 文档关系图
├── api/ # API 参考
└── <domain>/ # 按域组织的模块文档
支持 JS/TS/Python/Go/Rust/Java 等 10+ 语言,零外部依赖,完全离线可用。
怎么安装?
# 安装
npm install -g nium-wiki
# 加载为 Claude Code Skill
px skills add https://github.com/niuma996/nium-wiki --skill nium-wiki
然后在 Claude Code 里直接说:
generate wiki
create docs
update wiki
或者本地起文档预览服务器:
npx nium-wiki serve
# 打开 http://localhost:4000
本地服务器内置了交互式关系图谱:点击 Graph 按钮,可以可视化所有文件和文档的依赖关系。蓝色节点是源码,橙色节点是文档,边的类型有 import(导入)、refers(引用)、links(文档链接)三种。对于 500+ 节点的大项目,它会先加载核心节点再按需展开。
适合谁用?
- 接手老项目的工程师:文档早没了,Nium-Wiki 能快速生成一份可读的起点
- 团队 Tech Lead:代码评审时甩出一张架构图,比嘴讲清楚十倍
- AI Coding 进阶用户:Claude Code + Nium-Wiki 组合,把”读代码”这件事系统化
GitHub 上可以看完整示例项目 claude-code-sourcemap-wiki,是作者用 Nium-Wiki 给真实项目生成的文档,可以直接参考输出质量。
GitHub 链接:https://github.com/niuma996/nium-wiki
评论区
登录后可评论。