它到底是什么

一句话:用 AI 给你的代码库自动生成文档,然后把这些文档注入到 AGENTS.md / CLAUDE.md 里,让 Coding Agent 写代码时自带上下文。

你有没有遇到过这种情况:Claude Code 或者 Copilot 帮你写代码,结果因为不了解你的项目结构,生成的代码要么 import 路径错、要么风格不对、要么重复造轮子?问题不在于 Agent 笨,而在于它没有你脑子里的那份「项目地图」。

OpenWiki 就是来补这张地图的。它是 LangChain 团队做的,专门解决「Agent 写代码缺上下文」这个痛点。跑一条命令,它会扫描你的代码库,生成结构化文档,然后自动把这些文档的引用写进 Agent 的提示词文件里。

解决的核心痛点

Coding Agent 的上下文窗口有限,不可能每次都把整个代码库塞进去。传统做法:

方式问题
手写 AGENTS.md累,容易过时,项目大了根本写不全
让 Agent 自己读代码每次都要重新理解,浪费 token,结果不稳定
用 RAG 检索需要搭向量数据库,配置复杂,小型项目杀鸡用牛刀
直接贴 READMEREADME 是给人看的,不是给 Agent 看的,信息密度太低

OpenWiki 的思路很直接:生成一份 Agent 专用的项目文档,放在代码库里,然后在 AGENTS.md 里告诉 Agent「开工前先读这个」。简单、轻量、不需要额外基础设施。

技术架构拆解

核心流程

openwiki --init
    ↓
扫描代码库目录结构
    ↓
LLM 分析每个模块 → 生成结构化文档
    ↓
文档存入 openwiki/ 目录
    ↓
自动追加提示词到 AGENTS.md / CLAUDE.md
    ↓
Agent 启动时自动加载文档上下文

多模型支持

开箱支持多个 Provider:

预置了几个常用模型:GLM 5.2、Kimi K2.6、Sonnet 5 等,也可以自己指定任意模型 ID。配置存在本地 ~/.openwiki/.env,不会上传。

Agent 集成

这是 OpenWiki 最聪明的设计。它不只是生成文档,还会:

这样 Claude Code、GitHub Copilot、Cursor 这些工具启动时,会自动加载这些文档作为上下文。不需要你手动配置任何东西。

怎么用

安装

npm install -g openwiki

初始化

cd your-project
openwiki --init

第一次运行会让你选 Provider、填 API Key、选模型。之后配置存在本地,不用重复设置。

交互模式

openwiki

进入交互式 CLI,可以追问、调整文档内容。支持 / 命令,/exit 退出。

单次执行

openwiki -p "Summarize what you can do"

非交互模式,跑完自动退出。适合 CI/CD 集成。

更新文档

openwiki --update

代码改了之后跑一次,文档自动更新。

自动化每日更新

项目提供了 GitHub Action 模板 openwiki-update.yml,放到 .github/workflows/ 下,每天自动跑一次,有变化就开 PR。文档永远不会过时。

适用场景

和同类工具对比

工具定位OpenWiki 的差异
DeepWiki给代码库生成可浏览的 Wiki 站点OpenWiki 专注给 Agent 注入上下文,不生成网页
mentat / gptme终端里的 Coding Agent那些是 Agent 本身,OpenWiki 是给 Agent 喂文档的
aiderAI 结对编程 CLIaider 用 repo map 做上下文,OpenWiki 生成更详细的模块文档
手写 AGENTS.md人工维护 Agent 提示词OpenWiki 自动生成+自动更新,省掉人工维护成本

实际体验的一些坑

为什么值得关注

OpenWiki 的思路其实很简单:与其让 Agent 每次都重新理解你的代码,不如提前生成一份「项目说明书」塞给它。

这个想法不新,但 OpenWiki 的优势在于它是 LangChain 团队做的——他们最懂 Agent 需要什么样的上下文。而且它不只是生成文档,还自动处理了 AGENTS.md 的注入,整个流程闭环了。

4K Star 来得很快,说明这个需求确实存在。现在 Coding Agent 越来越多,但「怎么给 Agent 一个好的项目上下文」这个问题,还没有很好的通用方案。OpenWiki 至少提供了一个轻量级的答案。

项目地址:github.com/langchain-ai/openwiki