langchain-ai/openwiki

这是什么？

核心功能

• 01在仓库内生成可编辑、可版本管理的链接式 Markdown 文档。
• 02将页面中的事实与源码证据关联，代码变化时只更新受影响的内容。
• 03集成多种编码智能体，并通过 MCP 提供搜索与阅读工具。
• 04支持把多个仓库组织成工作区，实现跨项目搜索。
• 05提供本地可视化界面（交互式节点图加实时 Markdown 阅读器），也可导出为静态站点。
• 06兼容多家模型服务商，包括 OpenAI 兼容的本地接口。

适用场景

• 让编码智能体快速掌握大型或陌生代码库的整体结构。
• 通过定时 CI 任务提交更新 PR，保持入门和架构文档与代码同步。
• 将一个由多个仓库组成的服务整理为可统一搜索的工作区。
• 把架构关系图随生成的文档一起发布到静态站点。

快速上手

1. 1

   使用 npm 全局安装 OpenWiki（需要 Node.js 22.22.0 或更新版本）

   npm install -g openwiki
2. 2

   连接你的编程智能体（以 Codex 为例；其他智能体有各自的安装命令）

   openwiki integrations install codex
3. 3

   重启编程智能体，打开一个代码仓库，并让它根据源码和测试初始化 OpenWiki

4. 4

   在浏览器中以交互式图谱查看生成的 wiki

   openwiki visualize

使用前须知

• !需要 Node.js 22.22.0 或更新版本。
• !最简便的使用方式依赖受支持的编程智能体，且由智能体驱动的运行仅支持代码仓库 wiki，不支持个人知识库。
• !在 Windows 上，使用 bun 安装时可能需要编译 better-sqlite3 原生依赖，这需要 Visual Studio Build Tools。

入选 Repolode 开源周刊

• 第 3 期 · 本周：从 SSD 流式加载专家跑大 MoE，以及 Rust 毫秒级重编译

  一个 CLI，在仓库里生成并维护互相链接的 Markdown wiki，供编码智能体和人阅读。页面内容绑定源码证据，代码变动时只更新受影响的条目。

收录于专题

标签

常见问题

openwiki 是什么？

一个命令行工具，为代码库生成并维护链接互通的 Markdown 文档站，供编码智能体和开发者使用。 OpenWiki 会把代码仓库及其相关知识源整理成一套互相链接的 Markdown 文档，以普通文件的形式保存在仓库中，归你所有。编码智能体可以借助它理解代码、回答问题，并跨多个相关项目查找上下文；阅读者既可以直接浏览页面，也能在交互式节点图中查看。

openwiki 可以免费使用吗？用的什么许可证？

openwiki 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。

openwiki 还在维护吗？

活跃维护中。openwiki 最近一次提交是在 2026年11月6日。

openwiki 适合用来做什么？

让编码智能体快速掌握大型或陌生代码库的整体结构。 通过定时 CI 任务提交更新 PR，保持入门和架构文档与代码同步。 将一个由多个仓库组成的服务整理为可统一搜索的工作区。 把架构关系图随生成的文档一起发布到静态站点。

openwiki 怎么安装和运行？

使用 npm 全局安装 OpenWiki（需要 Node.js 22.22.0 或更新版本）: npm install -g openwiki 连接你的编程智能体（以 Codex 为例；其他智能体有各自的安装命令）: openwiki integrations install codex 重启编程智能体，打开一个代码仓库，并让它根据源码和测试初始化 OpenWiki 在浏览器中以交互式图谱查看生成的 wiki: openwiki visualize

在哪里获取 openwiki？

源代码和安装说明在 GitHub 上：https://github.com/langchain-ai/openwiki