项目简介
OpenWiki 是 LangChain 团队开源的「自我维护 Wiki CLI」——一个命令行工具，让 AI Agent 自动为你的代码库或个人知识库撰写并持续维护 Markdown 文档。它内置 Deep Agents 文档智能体，读取源码后合成带链接的 Wiki，每次代码变更都能自动更新；同时提供交互式可视化节点图，让你像浏览思维导图一样探索整个知识体系。
一句话总结：「为 Agent 写的文档，给人读的 Wiki。」
安装要求与快速上手
环境要求
- Node.js ≥ 18（推荐 LTS 版本）
- npm / pnpm 包管理器
- 任一 LLM 提供商 API Key（首次运行时引导配置）
安装步骤
# 全局安装 CLI
npm install -g openwiki
# 初始化代码库文档（交互式选择模型提供商）
openwiki --init
# 一键更新文档
openwiki --update
# 启动可视化浏览器
openwiki visualize个人知识库模式
# 初始化个人大脑模式
openwiki personal --init
# 认证数据源连接器
openwiki auth notion # Notion OAuth
openwiki auth gmail # Gmail OAuth
openwiki auth x # X/Twitter OAuth
# 执行全量数据摄取并生成 Wiki
openwiki ingest all核心功能
1. Agent 驱动的自动文档生成
基于 LangChain Deep Agents 框架的文档专用智能体，自动分析源码结构、模块依赖、函数签名和业务逻辑，生成结构化 Markdown 文档。支持 .openwikiignore 规则排除敏感路径（类似 .gitignore），确保私有信息不泄露。
2. 双模式：Code Wiki + Personal Brain
- Code 模式（默认）：扫描当前仓库，输出到
openwiki/目录，同时维护根目录的AGENTS.md和CLAUDE.md引导文件。 - Personal 模式：接入 Notion、Gmail、X/Twitter、Hacker News、Web Search 等数据源，将碎片化知识合成为本地 Wiki（存储在
~/.openwiki/wiki/）。
3. 12+ 模型提供商开箱即用
默认 OpenAI（gpt-5.6-terra），同时支持 Anthropic Claude、Google Gemini、AWS Bedrock、GitHub Copilot、OpenRouter、Nebius/Fireworks/Baseten/NVIDIA NIM，以及任何 OpenAI 兼容端点（Ollama、LM Studio、LiteLLM 网关等）。Copilot 用户可直接复用现有订阅，无需额外购买 API Key。
4. 交互式可视化浏览器
运行 openwiki visualize 即可启动本地 Web 服务，将 Wiki 渲染为交互式节点图 + 实时 Markdown 阅读器。左侧树形目录导航，右侧图谱展示概念关系，点击节点即时查看内容。编辑文件后自动热重载。
5. CI/CD 自动文档流水线
通过 GitHub Actions / GitLab CI / Bitbucket Pipelines 定时触发文档更新，每次提交自动生成 Docs PR。零成本无变更运行——OpenWiki 会快照对比，只有实际变化才记录元数据，避免 CI 积分浪费。
6. OKF 开放知识格式 & Mermaid 图表
输出符合 Google Open Knowledge Format (OKF) v0.1 标准，可移植到任何 OKF 兼容工具。自动在合适位置插入 Mermaid 图表（序列图、ER 图、状态机、流程图），且每次更新都验证图表有效性，损坏的图表会降级为纯文本并在下次修复。
典型使用场景
场景一：大型项目新人 Onboarding
一个拥有 200+ 微服务的后端仓库，新工程师通常需要两周才能理清架构。部署 OpenWiki 后，CI 在每次合并主分支时自动更新架构文档、模块关系图和 API 速查表。新人 clone 下来后 openwiki visualize 一眼看到全局，配合 AGENTS.md 让 AI 编码助手也能精准理解上下文。
场景二：个人知识中台
技术负责人的知识散落在 Notion 笔记、Gmail 重要邮件、Twitter 收藏的技术讨论和 HN 热帖中。OpenWiki Personal 模式一次性接入所有源，定期 ingest all 同步，自动去重、关联、归纳成带链接的知识网络。需要回忆某个技术决策时，可视化图中一眼定位。
场景三：Agent 记忆层
团队使用 Claude Code 或 Codex 做日常开发，但 Agent 的上下文窗口有限，无法容纳整个代码库历史。OpenWiki 生成的 AGENTS.md 作为持久记忆层，每次 Agent 启动时自动加载 Wiki 摘要，理解架构后再动手写代码，减少幻觉和无效重构。
推荐理由
作为 LangChain 官方出品，OpenWiki 解决了一个非常实际的问题：文档总是过时。传统方案要么靠人肉维护（没人愿意做），要么用静态文档生成器（只管骨架不管灵魂）。OpenWiki 的思路很聪明——把「写文档」这件事交给最懂代码的 Agent，同时保留人类对文档的所有权（纯 Markdown，版本控制）。
我个人最喜欢的三个设计：
① Copilot 复用——如果你已经有 GitHub Copilot 订阅，直接拿来跑推理，不用再掏钱买 API Key；
② .openwikiignore——安全意识很好，从根源上防止密钥泄露进文档；
③ 可视化节点图——不是花哨功能，对于理解陌生代码库真的有用，比翻几十个 README 快十倍。
13K+ Stars、日增上千的趋势也说明社区对这个方向的认可。如果你正在维护一个中等规模以上的项目，或者想让 AI 编程助手更懂你的代码库，OpenWiki 值得一试。
下载地址
- GitHub 仓库：https://github.com/langchain-ai/openwiki
- npm 包：https://www.npmjs.com/package/openwiki
- Deep Agents 框架：https://github.com/langchain-ai/deepagentsjs
