OpenWiki 调研:LangChain 官方出品的 14K stars 文档 Agent,AGENTS.md 自动维护 + 12 个模型 provider + OKF v0.1 开放输出

62次阅读
OpenWiki 调研:LangChain 官方出品的 14K stars 文档 Agent,AGENTS.md 自动维护 + 12 个模型 provider + OKF v0.1 开放输出

OpenWiki 调研:LangChain 官方出品的 14K stars 文档 Agent,AGENTS.md 自动维护 + 12 个模型 provider + OKF v0.1 开放输出

别再写 README 了,让 Agent 读你代码、自动生成 Wiki、每次 push 自动同步——LangChain 亲儿子,2 个月 14K stars。

写在前面

写代码的人最恨两件事:写文档 ,和 文档过时

OpenWiki 解决的是第二件——文档自动跟随代码变。它是 LangChain 团队(做 LangGraph / DeepAgents 的那帮人)2026-06-22 上线的 CLI,2 个月涨到 14K stars,最近 2 周几乎每天一个 minor 版本,v0.3.1 是昨天(8/5)才发

它跟传统 Wiki 系统(MediaWiki / DokuWiki / Wiki.js / BookStack)完全不是一个物种——OpenWiki 不是给人协作编辑的 Wiki,是给 Agent 当 Memory 用的 Markdown 知识库

“It is built for agents to read as memory, and it ships an interactive visualizer for humans to explore.”

它给每个 repo 生成一份 openwiki/ 目录下的 Markdown Wiki,然后 自动往 AGENTS.md / CLAUDE.md 写一个指针块 ,让 Claude / Cursor 这些 coding agent 直接消费这份 wiki 作为长期记忆


一、它解决什么问题

OpenWiki 是一套给 codebase 维护文档的 CLI Agent。输入:你的 git 仓库(或你的 Notion / Slack / Gmail / X)。输出:本地 Markdown Wiki 文件,每次变更自动重新生成。

一句话卖点:让 Agent 读代码 + 写文档 + 同步 AGENTS.md,文档不再腐烂

基本信息

字段
GitHub langchain-ai/openwiki
NPM openwiki
官网 通过 LangChain 文档站分发
创建时间 2026-06-22(不到 2 个月)
Stars / Forks 14,188 / 1,013
Open Issues 137(活跃社区)
License MIT(✅ 商用无忧)
主语言 TypeScript 1.5M / JavaScript 117K / Python 109K
最新版本 v0.3.1(2026-08-05 昨天发布)
Releases 节奏 14 个,最近 2 周几乎每天一个 minor 版本
主贡献者 bracesproul (77) + colifran (30) + HwangJohn (18) + LangChain 团队

为什么是 LangChain 官方?

OpenWiki 不是独立作者项目,是 LangChain 团队官方出品。它底层用的是 langchain-ai/deepagentsjs——LangChain 自家的 Deep Agent 框架(LangGraph 之上的 agent loop)。

核心背书 :LangChain / LangGraph 生态已经做了 3 年,DeepAgents 是他们 2026 年的新主线(blog.langchain.com/deep-agents),OpenWiki 是 第一个拿 DeepAgents 当产品形态的项目


二、两种模式:一个 CLI 走两个场景

OpenWiki 有两种完全独立的使用模式:

模式 文档对象 输出位置 启动
Code(默认) 当前仓库的代码 <repo>/openwiki/ openwiki --init
Personal 你的连接源(Notion/Slack/Gmail/X/Web/HN) ~/.openwiki/wiki/ openwiki personal --init

Code 模式:仓库文档自动维护

npm install -g openwiki
cd my-repo
openwiki --init        # 首次:选 provider/key/model → 生成 openwiki/
openwiki               # 增量:读 diff → 更新 wiki
openwiki --update      # 等价的显式 update
openwiki visualize     # 启动 node graph 可视化器

启动后会写:

openwiki/ 目录下的 Markdown Wiki

AGENTS.md / CLAUDE.md<!-- OPENWIKI:START -->...<!-- OPENWIKI:END --> 块(指针,不会覆盖你的其他内容

openwiki/.langsmith.json(如果接了 LangSmith 追踪)

Personal 模式:个人知识库自动聚合

openwiki auth notion         # 本地浏览器 OAuth
openwiki auth gmail
openwiki ingest all          # 跑所有配置的 source
openwiki ingest web-search   # 跑单个 source(可配置多个实例)

支持的连接器:

连接器 用途
git-repo 本地 git 仓库路径
notion 走 Notion 官方 MCP,OAuth 鉴权
slack 需要 app client credentials
google (Gmail) Gmail API + OAuth
x (Twitter) X API + OAuth 2.0 PKCE(时间线 / 帖子 / 书签 / 列表)
web-search 走 Tavily(需 TAVILY_API_KEY)
hackernews 公开 API,无需鉴权
langsmith 拉 trace(tool call / 延迟 / 结果)到 code wiki

每个 connector 在 ~/.openwiki/connectors/<name>/raw/ 写原始数据 + manifest,然后 agent 在 ~/.openwiki/wiki/ 合成 wiki。同一个 connector 可配多实例(比如 web-search-1 关注 AI 资讯,web-search-2 关注 NBA 比赛)。


三、核心能力详解(从 git init 到自动同步只要 3 步)

1. 12 个模型 provider 开箱即用

类型 Provider
闭源主流 OpenAI · Anthropic · Google Gemini · Bedrock
OpenAI 兼容 任何 OpenAI-compatible 网关(vLLM / OpenRouter / 自建)
GitHub Copilot ✅ 复用现有 Copilot 订阅,无需单独 API key

CLI 第一次启动会走 setup wizard:选 provider → 填 key → 选 model。

2. .openwikiignore —— 熟悉的 gitignore 语法

node_modules/
dist/
*.generated.ts
.openwiki-cache/

.gitignore 一致的语法,排除生成代码 / 私有路径 / 不相关目录

3. 自动同步到 AGENTS.md / CLAUDE.md

OpenWiki 在每次 code 模式下运行后,会往 repo 根的 AGENTS.mdCLAUDE.md 写一个指针块

<!-- OPENWIKI:START -->
The project wiki is at `./openwiki/`. Read relevant concept documents
before making architectural decisions in this repository.
<!-- OPENWIKI:END -->

关键设计 :用 HTML 注释围栏, 只动 OPENWIKI 块内的内容,其他部分一字不改。这意味着你已有的 AGENTS.md 内容(团队规范 / review checklist)不会被覆盖。

4. CI/CD 自动更新(GitHub Actions / GitLab CI / Bitbucket)

仓库自带 3 个 CI 模板:

  • examples/openwiki-update.yml → GitHub Actions
  • examples/openwiki-update.gitlab-ci.yml → GitLab CI
  • examples/openwiki-update.bitbucket-pipelines.yml → Bitbucket Pipelines

配好 CI 后,每次 push 自动 open PR 更新文档no-op 运行零成本(OpenWiki 快照 openwiki/ 目录,无变化不记录元数据,避免 CI 噪声)。

5. LangSmith 集成 —— 文档跟随运行时行为

这是 OpenWiki 最有 ”agent native” 味道的能力:

# 在 openwiki --init 时,从 source 菜单选 LangSmith
# 选 workspace region(US / EU)# 列出要文档化的项目

OpenWiki 会读 LangSmith trace(tool call / outcome / latency),把运行时实际行为写进 wiki。意味着文档不仅跟代码走,还跟运行时行为走——比单看 source 更准确。

API key 只放 env var:OPENWIKI_LANGSMITH_API_KEY=<key>配置文件只存 workspace + project 名,不存 key

6. 可视化器:Node Graph + Markdown 同屏阅读

openwiki visualize
# 默认起在 127.0.0.1:4321,不对外暴露
# 服务 ./openwiki/ 目录,编辑文件自动热重载

可视化器把 wiki 转成 live explorable node graph,左边图、右边 Markdown 同屏显示:

  • 节点 = 概念文档
  • 边 = 文档之间的链接
  • 点击节点 → 右侧渲染 Markdown
  • 自动渲染 Mermaid 图

openwiki visualize openwiki --port 4400 --no-open:指定目录 + 端口 + 不自动开浏览器。

7. 多语言输出

openwiki --language zh-CN    # 生成中文 wiki,代码 / 标识符保留 canonical
openwiki --language ja       # 日文

代码 / 类名 / 函数名保持英文原样,正文叙述翻成目标语言


四、和传统 Wiki 系统对比

维度 OpenWiki Wiki.js BookStack MediaWiki DokuWiki
定位 Agent 文档生成器 团队协作 Wiki 文档管理 维基百科引擎 轻量 Wiki
输入 Agent 自动读代码 / 源 人手写 Markdown 人手写富文本 人手写 WikiText 人手写
维护 每次 push 自动 手动 手动 手动 手动
输出 AGENTS.md 可消费的 Markdown Markdown HTML WikiText 纯文本
可视化 ✅ Node Graph
双模式 ✅ Code + Personal
License MIT AGPL-3.0 MIT GPL-2.0 GPL-2.0
Stars 14K(2 个月) 24K 16K 41K 4.6K
AGENTS.md 集成 ✅ 指针块自动写
MCP 友好 ✅ Notion 走 MCP
可作为 Agent Memory 核心设计目标

核心区别一句话 :传统 Wiki 是 ” 人写给人读 “,OpenWiki 是 ”Agent 写给 Agent 读“——这是 AI Coding 时代 才出现的需求。


五、和 AI Coding 工具的对比

工具 角色 关系
Claude Code / Cursor / Cline 写代码的 Agent OpenWiki 给它们提供 AGENTS.md 长期记忆
LangChain DeepAgents Agent 框架 OpenWiki 是它的第一个产品形态应用
LangSmith Trace 平台 OpenWiki 拉 trace 写进 wiki
aider / Continue.dev AI Coding 助手 OpenWiki 替代它们的 ” 项目记忆 ” 层
MCP server 工具调用协议 OpenWiki 内部用 MCP 接 Notion

OpenWiki 的独特定位:是 AI Coding Agent 和项目知识之间的粘合层——Claude Code 没有持久化的项目知识(每次新会话都从头),OpenWiki 提供 <repo>/openwiki/ 目录 + AGENTS.md 指针,让 Agent 开局就有项目上下文。


六、实战:3 步跑通(Code 模式)

Step 1:装 CLI + 选 provider

npm install -g openwiki   # 或 pnpm add -g openwiki

cd my-project
openwiki --init

# 启动 wizard:#   ? Pick a provider: anthropic
#   ? API key: sk-ant-...
#   ? Model: claude-sonnet-4-5

Step 2:生成 wiki + 接 CI

# 首次跑完,openwiki/ 目录就出来了
ls openwiki/
# index.md  architecture.md  modules/  ...

# 复制 CI 模板
cp examples/openwiki-update.yml .github/workflows/openwiki-update.yml

# 在 repo secrets 里加 OPENWIKI_ANTHROPIC_API_KEY

Step 3:自动同步 + 可视化

# 本地增量更新
openwiki

# 启动可视化器看 node graph
openwiki visualize
# → 浏览器自动开 http://127.0.0.1:4321

每次 push,CI 跑 openwiki --update生成 docs PR


七、风险与坑

  1. 2 个月历史,137 open issues:v0.3.x 还在快速迭代,生产建议锁版本(不要 npm i -g openwiki@latest)。看 8/4 的 commit 主题——内部 link validator 在误判、版本包脚本还在调
  2. 依赖 model provider 质量 :wiki 质量 = agent 质量 = model 质量。 小模型(Haiku / GPT-4.1-mini)输出的 wiki 容易丢关键架构决策,建议 Sonnet / Opus 起步
  3. 大仓库首次跑贵 :agent 要读所有文件 + 生成所有 wiki 节点。1 万行代码 + Opus 可能烧几美元,CI 自动跑的话 强烈建议预算控制 + no-op 跳过
  4. 个人模式需要大量 OAuth 配置 :Notion / Slack / Gmail / X 都要各自的 OAuth app, 首次接入成本不低,新手从 web-search + hackernews 这两个零配置 connector 起步最划算
  5. .openwikiignore 要提前规划 :不想被文档化的目录(私人脚本 / 实验代码 / 生成的 .pb.go), 第一天就要写进 .openwikiignore,否则 agent 会浪费 token 去读
  6. LangSmith 集成需要 EU/US workspace 区分:key 是 workspace + region 绑定的,多 workspace 要用 OPENWIKI_LANGSMITH_API_KEY_2_3 后缀
  7. OKF v0.1 还是早期规范 :输出的开放格式目前 只有 LangChain 自己的工具链完整支持 ,第三方消费端还在路上。 长期来看是利好(避免锁定),短期可能 ” 存了但用不上 ”
  8. Windows 上 bun 安装会触发 C++ 编译:better-sqlite3 native dep 要 Visual Studio Build Tools,Windows 用户用 npm/pnpm 更稳

八、总结

3 个最值得装的理由

  1. LangChain 官方 + 14K stars + 每天发版 —— 不是社区玩具,是 LangChain 战略级产品。DeepAgents 框架的第一个落地形态,未来 LangChain 生态的 ” 项目记忆标准 ” 候选
  2. AGENTS.md 自动维护 = Coding Agent 真正可用——Claude Code / Cursor / Cline 这些工具目前最痛的就是 ” 项目记忆缺失 ”,每次新会话都重新摸代码。OpenWiki 直接给它们一份活的 wiki
  3. 双模式 + 12 model providers + MIT + OKF 输出——既能文档化仓库,又能聚合个人知识源;不锁定模型(GitHub Copilot 都能复用);输出开放格式避免 vendor lock-in

1 句试水建议

先在一个 5K 行以内的真实项目跑 openwiki --init,看它给 Claude Code 提供的 AGENTS.md 上下文质量。比手动维护 README/docs 强 10 倍,比雇文档工程师便宜 100 倍——前提是你接受 agent 写文档的不确定性,并且配 Sonnet/Opus 而不是 mini 模型。


参考

  1. GitHub: langchain-ai/openwiki
  2. NPM: openwiki
  3. GitHub: langchain-ai/deepagentsjs(底层框架)
  4. LangChain Blog: Deep Agents 介绍
  5. Google Open Knowledge Format (OKF) v0.1 spec
  6. GitHub: Wiki.js(传统 Wiki 对照)
  7. GitHub: BookStack(传统 Wiki 对照)
  8. GitHub: MediaWiki(传统 Wiki 对照)
正文完