OpenWiki：给代码仓库装一个会自我更新的「项目大脑」

📝

LangChain AI 开源的 CLI 工具（13,344⭐，MIT），TypeScript 编写。自动分析代码仓库生成结构化项目 Wiki，维护 AGENTS.md/CLAUDE.md 入口，支持 CI 定时更新 PR。基于 DeepAgents，写入边界严格限制在 openwiki/ 目录，不会误改业务代码。

原文链接：OpenWiki：给代码仓库装一个会自我更新的”项目大脑”
作者：大咪
仓库：github.com/langchain-ai/openwiki（13,344⭐，MIT，TypeScript）

未来代码仓库不只给人读，也会给 AI Agent 读。仓库需要一层稳定、持续更新、能被 Agent 优先消费的知识结构。

核心能力

OpenWiki 是 LangChain AI 开源的 CLI 工具，解决的不是「缺文档」，而是缺一个能持续跟着代码变化更新的项目知识层。

Code mode：给代码仓库生成文档

分析仓库后生成 openwiki/ 目录：

项目 Quick Start
架构概览与模块分工
运行和部署方式
测试与维护建议
给后续 AI Agent 使用的上下文说明

同时维护 AGENTS.md 和 CLAUDE.md 片段，告诉后续 Agent：先读 Wiki，别乱扫仓库。

Personal mode：构建个人知识 Wiki

从 Git 仓库、Gmail、Notion、Web Search、Hacker News、Slack、X/Twitter 等连接器拉取内容，整理到 ~/.openwiki/wiki/。

5 分钟跑起来

npm install -g openwiki
cd your-repo
openwiki --init       # 交互式配置 LLM provider
openwiki --update     # 更新已有 Wiki
openwiki -p "Summarize what this repository does"
openwiki code --init --print  # Code mode 非交互式

要求：Node.js ≥22 + 一个 LLM API Key（OpenAI/OpenRouter/Anthropic/Gemini/Bedrock 等）。

架构设计

核心链路

1 2	CLI → 模式解析(code/personal) → 加载凭证 → 创建 DeepAgent → 挂载受控文件系统 → 读取源码/文档/Git信息 → 生成/更新 Wiki → 写入 openwiki/

四个关键设计

设计点	说明
基于 DeepAgents	不是从零造 Agent，天然适合长任务仓库分析
写入边界控制	init/update 模式严格限制只写 `openwiki/`，不碰业务代码
多模型供应商	OpenAI/OpenRouter/Anthropic/Gemini/Bedrock/Fireworks/Baseten/NIM/OpenAI-compatible
先落证据再综合	Connector 拉取原始数据 → 本地 raw → Agent 综合（可控、可审计）

AGENTS.md / CLAUDE.md 片段

OpenWiki 在仓库根目录写入受控区块：

<!-- OPENWIKI:START -->
## OpenWiki
This repository uses OpenWiki for recurring code documentation. 
Start with `openwiki/quickstart.md`
<!-- OPENWIKI:END -->

只更新自己控制的区块，不覆盖原有内容。

CI 自动更新

name: OpenWiki Update
on:
  workflow_dispatch:
  schedule: [cron: "0 8 * * *"]
jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      - run: npm install --global openwiki
      - run: openwiki code --update --print

生成文档更新 PR，人工 Review 后合并。

落地建议

1	本地初始化 → 人工审查 → 纳入代码评审 → 接入 CI 定时更新 PR

场景	建议频率
活跃项目	每天一次
普通业务仓库	每周一次
重大架构变更	手动触发一次

优势

同时服务人和 AI——文档组织方式专为 Agent 消费优化
安全边界——文件系统后端限制只写 openwiki/，不靠 prompt 约束
CI 闭环——定期更新 + PR review，文档不落后
模型灵活——OpenAI/OpenRouter/Anthropic/Bedrock 等全支持

限制

版本 0.1.2，还在快速迭代
生成内容仍需人工 Review——“能干的文档实习生”，不是技术负责人
Token 成本不可忽视
不替代源码中的权威文档（OpenAPI、ADR 等）

评价

OpenWiki 最打动人的不是「AI 自动写文档」，而是抓住了一个正在变重要的问题：代码仓库需要为 AI Agent 准备长期记忆。这件事，接下来会越来越重要。