用途:为代码库生成并维护一份持久的、互链的 Markdown wiki,覆盖架构、模块、模式与 API。基于 Andrej Karpathy 的 LLM Wiki 思路,把原始代码“编译”成结构化、随时间累积的知识库。
模式判断:不存在 .llm-wiki/ 时进入 Full Build 模式;已存在则进入 Update 模式(对比差异并刷新)。
Full Build 流程:一、侦察:读取顶层文件(README、package.json 等),用 find/Glob 映射目录树(忽略 node_modules、.git、vendor 等),识别语言、框架、构建系统、入口、测试框架,并读取 CLAUDE.md/AGENTS.md/.cursor/rules,把发现记录到 .llm-wiki/_schema.md。二、骨架:创建 _schema.md、_index.md、_log.md 及 architecture/、modules/、concepts/、apis/、guides/ 目录。三、核心文章:按优先级撰写 architecture 下的 overview、data-flow、directory-structure,再写各模块、横切概念、API 与指南文章。四、索引与互链:_index.md 按类别组织,每篇文章含 See Also 并建立双向链接。五、Lint:检查断链、孤立页、覆盖缺失、失效引用与术语不一致,修复后记入 _log.md。
Update 流程:读取 _schema.md 与 _log.md,借助 git log --since="<last_update>" --name-status 或目录树对比检测变更,分类处理新增、修改、删除与重命名,更新受影响文章与 _index.md,再执行 Lint 并追加日志。
写作规范:忠于代码事实并引用文件路径与行号,使用真实短代码片段,积极互链,单篇 100-500 行,每篇以 YAML frontmatter(title、updated、sources)开头,优先 ASCII 图,语言与项目主语言一致。大型代码库(>500 源文件)可派并行代理。默认建议将 .llm-wiki/ 随代码提交以惠及团队,仅在用户偏好时加入 .gitignore。
限制:具体安装命令、收费与平台支持资料暂未提供。