langchain-ai/openwiki

OpenWiki is a CLI that writes and maintains agent documentation for your codebase.

OpenWiki – 面向代码库的自托管、代理驱动文档

简介 – OpenWiki 是一款基于 Node 的工具，可让大型语言模型编码代理（例如 Claude Code、Codex、Cursor、GitHub Copilot、IBM Bob 等）在仓库内自动生成并持续更新一个链接的 Markdown wiki。wiki 以你拥有的普通文件形式存储，代理可以使用轻量级、模型无关的工具（openwiki_search、openwiki_read）进行查询。

主要功能

代理集成 – 为许多流行的编码代理提供一键安装程序。代理使用自身经过身份验证的模型会话，因此你无需配置单独的服务商。
基于证据的页面 – 每个 wiki 页面都与源代码证据（代码、测试、文档）相关联。主张会进行版本管理；当仓库发生变化时，OpenWiki 仅重写证据发生漂移的页面。
并行页面工作器 – CLI 可以并行处理多个页面的文档（可通过 OPENWIKI_PAGE_CONCURRENCY 配置），并自动处理服务商的速率限制。
工作区 – 使用 openwiki link 将相关仓库分组；代理可以搜索整个服务，并读取任何成员 wiki 的章节。
可视化浏览器 – openwiki visualize 运行一个本地服务器，将 wiki 显示为交互式节点图，并配有实时 Markdown 查看器。它还可以导出静态可视化工具，用于托管在 GitHub Pages 上。
定时 CI 更新 – 预制的 GitHub Actions、GitLab CI 和 Bitbucket Pipelines 片段会在 wiki 与代码出现差异时打开一个 PR。
个人模式 – 除了仓库文档，你还可以构建一个个人知识 wiki（openwiki personal），聚合任何已连接的源。

安装

# 需要 Node 22.22+
npm install -g openwiki   # 全局安装（或通过 Pi: pi install npm:openwiki）

然后为你的编码代理安装集成，例如：

openwiki integrations install codex   # 或 claude、cursor、bob、kiro、omp、antigravity、copilot

典型工作流程

初始化 – 在仓库内，让代理执行“初始化此仓库的 OpenWiki…”。代理在 openwiki/ 下编写一个链接的 wiki。
查询 – 在后续会话中，让代理使用 openwiki_search 搜索主题，并使用 openwiki_read 阅读相关章节。
更新 – 在代码更改后，让代理执行“更新此仓库的 OpenWiki…”。OpenWiki 会检查差异、验证现有主张，并仅重写所需内容。
探索 – 运行 openwiki visualize 浏览图，或导出静态可视化工具。
自动化 – 添加提供的 CI 工作流（openwiki-update.yml）以自动保持 wiki 同步。

配置

并发数：OPENWIKI_PAGE_CONCURRENCY=4
状态目录：默认为 ~/.openwiki；可通过 OPENWIKI_CONFIG_DIR 覆盖。
服务商选择：CLI 在首次运行时提示选择模型服务商；支持十四个服务商。

为什么重要 – 文档保持与代码紧密相关，由编写它的同一 LLM 持续刷新，并且保持完全可编辑的 Markdown。代理无需额外 API 调用即可获取准确、有依据的上下文，从而改善代码理解、调试和入职体验。

快速开始

npm install -g openwiki
openwiki integrations install codex   # 选择你的代理
# 在仓库内的代理聊天中：
Initialize this repository's OpenWiki from the current source and tests.

现在你拥有了一个可搜索、可可视化的 wiki，且完全属于你。