今天来说说 LangChain 刚开源的 OpenWiki。
思路很对:别把几百页仓库说明塞进 AGENTS.md,而是生成一套 openwiki/,再在 Agent 指令文件里挂一句「先读 wiki」。Cursor、Claude Code、Codex 都能吃这套约定。
真上手才发现卡点:OpenWiki 是独立 CLI,生成和更新都要自己配模型 API Key。Cursor 订阅是一份钱,文档生成又是一份钱。团队里一半人只想在 IDE 里说一句「初始化文档」,不想再管一套 Key。
所以我把 OpenWiki 里真正适合进 IDE 的能力,收成了一个 Skill:openwiki-docs。仓库在 github.com/tunsuy/ai-skills,目录名就是 openwiki-docs。
Coding Agent 写代码,最怕两件事:
一是上下文全靠当场扫仓库,大仓又慢又容易漏; 二是文档写过一次就烂掉,没人维护。
业界常见几层做法:
层 | 典型形态 | 解决什么 |
|---|---|---|
常驻约束 | AGENTS.md / Rules | 怎么写、别踩坑 |
流程能力 | Agent Skills | 发版、审计、脚手架 |
活数据 | MCP / 索引 | 库文档、issue、符号图 |
仓库知识层 | OpenWiki / 自建 docs | 架构、流程、源码地图 |
OpenWiki 打在第四层,而且打对了:wiki 落盘 + 挂到 AGENTS.md + 可增量更新。缺的是「在 Cursor 里用 IDE 额度直接跑」这一环。
社区里还有 wiki-architect(偏一次性目录/onboarding)、各种 Context Keeper(偏会话记忆)。它们有用,但和「可维护的仓库 wiki + Agent 入口」不是同一件事。
能搬进 Skill、且不依赖官方 CLI 的,主要是这几块:
openwiki/(quickstart、architecture、workflows 等)AGENTS.md / CLAUDE.md 写入 <!-- OPENWIKI:START --> 引用块故意没搬的:
一句话:约定和流程进 Skill,平台能力仍留给官方 CLI。 目录名、页面职责、OPENWIKI 标记都对齐官方 code mode,以后真要切回 openwiki CLI,也不至于推倒重来。
openwiki-docs/
├── SKILL.md
├── references/
│ ├── wiki-schema.md # 目录与页面约定
│ └── agents-block.md # AGENTS 引用块全文
└── scripts/
└── changed-files.sh # 自上次同步以来的变更文件
Agent 引用块长这样(标记内外分区,外面你原来的规则不动):
<!-- OPENWIKI:START -->
## OpenWiki
This repository uses OpenWiki for recurring code documentation.
Start with `openwiki/quickstart.md`, then follow its links...
<!-- OPENWIKI:END -->
changed-files.sh 会读 openwiki/_meta.md 里的 last_sync_commit,列出之后变更的文件,update 时按路径映射到该刷新的 wiki 页。没 git 记录就退化为小范围重扫,不硬报错。
1. 拷到 Cursor 能发现的位置
# 全局
cp -R openwiki-docs ~/.cursor/skills/
# 或项目级
cp -R openwiki-docs your-project/.cursor/skills/
2. 打开目标仓库,Agent 里直接说
初始化 openwiki / 生成 agent 代码知识库更新 openwiki只把 openwiki 挂到 AGENTS.md3. 检查产物并提交
仓库里应出现:
openwiki/quickstart.md 等页面AGENTS.md、CLAUDE.md 里的 OPENWIKI 块建议一起进版本库,团队共享同一份 Agent 上下文。
跑完不需要再配 OpenWiki 的 API Key。生成用的是 Cursor(或 Claude Code / Codex)自己的模型额度。
场景 | 更合适的选择 |
|---|---|
只想在 IDE 里建/刷 wiki,不想另配 Key | openwiki-docs Skill |
要 personal brain、多源 connector、官方 CI 流水线 | OpenWiki CLI |
已经有官方 openwiki/,只想 Cursor 读 | 两边都行,读同一套目录即可 |
我个人习惯:日常用 Skill 维护;团队若上了统一的 CI Secret,再把官方 --update 接进流水线做夜间刷新。Skill 负责「人在 IDE 里随手来一发」,CLI 负责「无人值守」。
适合:
不太适合:
wiki-architect 更轻代码知识库不是一个插件打天下,而是分层:Rules 管约束,Skill 管流程,wiki 管仓库事实,MCP 管活数据。openwiki-docs 只把其中「仓库事实层」接到 IDE 里。
OpenWiki 把「Agent 该读什么」从巨型指令文件里拆了出来;openwiki-docs 把这件事搬进 Cursor Skill,让你用 IDE 额度完成 init / update / 挂接 AGENTS,还不丢和官方的兼容约定。
仓库地址:https://github.com/tunsuy/ai-skills(目录openwiki-docs)
你在项目里搭 Agent 知识库时,是更倾向官方 CLI,还是 IDE 内 Skill?评论区聊聊你的取舍,我也想看看有没有该补的更新策略。
觉得有用的话,点赞👍 + 在看👀 + 收藏⭐ 一键三连,下次找起来方便,也能让更多人看到。