OpenWiki

OpenWiki

给代码库生成AI文档

AI官网

应用介绍

让 AI 改一个自己没见过的仓库,最费口舌的不是写代码,是解释这个项目:用了什么技术栈、目录怎么分、模块之间谁依赖谁、某个约定为什么是这样。换一个仓库,这套解释就得从头再来一遍。

OpenWiki 的做法是把这份解释一次性写成 wiki——一个命令行工具,让 agent 读一遍你的代码库,产出一套互相链接的 Markdown 文档,专门给 coding agent 当项目说明书用。文件就落在你仓库里,是你自己的 Markdown,不是存在别人服务器上的东西。

它和传统的项目文档不是一回事:传统文档写给人看,写完就开始过期;OpenWiki 是写给 agent 读的,而且能挂到 GitHub Actions、GitLab CI 或 Bitbucket Pipelines 上定期跑,代码变了文档跟着更新。

另外它给每个页面记了可信度元数据——哪些说法有代码证据支撑、支撑到什么程度,都标出来。文档写错比没有文档更坑,这一层是用来兜底的。人要看的话,它自带一个可视化界面:左边是页面关系的节点图,点一下右边就是对应的 Markdown。

软件功能



Agent 生成文档:由文档 agent 通读代码库后产出互相链接的 Markdown wiki,不是模板套出来的目录清单。

直接接入编码工具:能和 Codex、Claude Code、OpenCode、Cursor 集成,借用宿主的模型和仓库工具跑,不用另配一套。

CI 自动更新:可以挂在 GitHub Actions、GitLab CI 或 Bitbucket Pipelines 上定期执行,让文档跟着代码一起变。

页面级可信度:用 OKF 格式给每个页面记录证据与信任度,标明哪些结论有代码依据,减少文档说谎的情况。

可视化浏览:自带交互式界面,左侧节点图展示页面之间的关系,点开即读右侧 Markdown,适合人快速摸清项目全貌。

两种模式:`code` 模式针对代码仓库,`personal` 模式用来整理自己的知识库。

模型可选:支持多家模型服务,也能接本地 Ollama,不绑定某一家。

文档归你:产出的就是仓库里的 Markdown 文件,随时可读可改可删,不依赖任何托管服务。

应用截图