又一个 AI 文档神器，开源了！

有没有遇到过这种情况？

代码已经写完，功能也已经测试完毕了，准备提交项目了。

结果打开 README，半天不知道从哪写起。

并不是由于文档不会写，是真不想写。

一般都会拖到最后。

更麻烦的是，代码改了几次，文档很快又跟不上了。

LangChain 最近开源了一个叫 OpenWiki 的 CLI 工具,专门解决这个问题。

在 GitHub 上,它已经收获了 10100 多个 Star。

开源地址：

它的作用就是让你的 AI 帮你读代码、写文档，并且每天自动同步更新。

它就是用来为代码库自动生成和维护文档的命令行工具。

我给你演示一把,你就会知道这个东西有多么方便了

打开你的终端,跑一行命令:npm install -g openwiki。

装好之后,进入你的项目目录。

然后运行命令openwiki code --init。*

会让你选择一个AI模型，例如OpenAI、Anthropic。

填入API Key之后，就会开始自动读取你的整个项目代码结构。

对目录、模块、函数和注释进行分析，理解你的代码逻辑。

5 分钟之内就可以完成一份规范的文档。

执行完看到一个 openwiki/ 目录。

大致看了一下有架构说明、安装配置、API端点列表、开发规范等内容。

然后我还在根目录发现一个叫 AGENTS.md 的文件。

查了一下，它的作用是是：

引导 Agent 去读生成的 wiki 文档来提高效率。

它是怎么做到的

01 一个命令就产生了整个文档。

它不会只扫描一遍文件目录。

它先对整个项目进行分析，包括目录结构、模块之间的关系、函数接口以及代码注释等，尽量弄清楚项目的组织方式。

然后自动生成五种类型的文件：

• 项目概览
• 项目结构图
• 安装与配置说明
• API 端点列表
• 开发规范

生成的文档放在 openwiki/ 目录下，不会对你的项目结构产生任何影响。

02 每天自动同步,文档实时更新。

它提供了一个 --update 参数。

在更新文档的时候，底层会用 git diff 来获取代码的变化内容，然后让 AI 对这些变化进行分析，并且只更新被影响到的文档。

这样就不用每次都重新生成全部文档。

可以省不少 token。

03 自动告知你的 AI 去读文档。

文档生成完，它会在 AGENTS.md 中添加一条提示。

让Agent去读生成出来的Wiki。

该设计很巧妙，并不是把所有的文档都放到指令文件里，而是只放了一个简单的指针。

在要用到的时候再查询，又可以省一些token。

04 自动化,完全不用手动。

它提供完整的 workflow，可以按照计划执行，例如每天一次。

自动生成PR来更新文档，并且不会直接提交到主分支上。

可以等到review之后再合并，来保证文档的质量。

workflow 配置参考
examples/openwiki-update.yml，你只需要把它们复制到.github/workflows/目录下就可以使用了。

这样文档就可以每天自动更新了，不需要人工去维护。

05 支持多种模型,成本可控。

OpenWiki 支持 OpenRouter、OpenAI、Anthropic、Fireworks、DeepSeek 等多种 provider。

可以使用Claude Sonnet，也可以使用价格更低的模型，如DeepSeek。

第一次运行的时候会要求你选择provider、输入API key、选择模型。

配置保存在本地的 ~/.openwiki/.env 文件中，并不包含在 git 历史里。

还可以设置自己的baseURL，可以接入自己搭建的gateway或者代理。

预定义的模型包括 GLM 5.2、Kimi K2.6、Sonnet 5 等,但你可以自定义 model ID。

另外支持OpenAI-compatible endpoints，可以接入任何兼容OpenAI API的服务。

看完这些功能，估计不少朋友已经想上手试试了

全局安装一条命令：

npm install -g openwiki

进入到你的项目目录中去执行初始化：

openwiki code --init

选择好模型之后，填写API Key，然后就可以自动生成文档了。

要实现自动更新的话，就把示例 workflow 复制到 .github/workflows/ 目录下。

每天自动运行，你只需要进行Merge。

写在最后

试用了之后，我认为OpenWiki可以解决文档过时的问题。

尤其是对一些规模较大的项目来说，该工具几乎就是救命稻草了。

但是它并不是万能的。

如果项目比较小的话，自己写文档可能更省事。

如果代码的质量很差的话，那么生成出来的文档也不会很好。

它适合这些场景:项目有必定规模,代码质量还行,团队成员用 AI 编程工具,又不想花时间维护文档。

感兴趣的可以试试。