openwiki

为代码库自动写文档，让 AI 智能体更懂你的项目

开源 🏷️完全免费 🔧 仅开源项目，无在线服务，需自行部署编程开发 🍴 复刻 1307 🐛 待处理 183 👀 关注 54

GitHub ↗

GitHub 星标 ★ 17700

维护状态活跃

是否开源开源

定价模式 🏷️完全免费开源免费，无在线服务，需自行安装 CLI 使用

项目预览

项目数据

分类编程开发

开发团队langchain-ai

GitHubhttps://github.com/langchain-ai/openwiki

定价模式🏷️完全免费

价格说明开源免费，无在线服务，需自行安装 CLI 使用

访问状态🔧 仅开源项目，无在线服务，需自行部署

是否开源是

开源协议MIT

主要语言TypeScript

GitHub 星标★ 17700

上线时间2026-06-22 00:00:00

代码更新2026-11-03

仓库体积38.2 MB

本站数据更新2026-11-03

维护状态活跃

收录时间2026-09-12

浏览次数1

项目介绍

OpenWiki 是一个基于 TypeScript 开发的命令行工具，专门为代码库自动生成并维护面向 AI 智能体（agent）的文档。它解决的核心问题是：当开发者使用 Claude Code、Cursor 等编码智能体时，智能体往往缺乏对项目结构、模块职责和关键约定的准确理解，导致生成的代码不符合项目规范。OpenWiki 通过扫描代码库，自动提取目录结构、依赖关系、公共 API 和重要配置文件，生成结构化的 Markdown 文档，并能在代码变更后持续更新，让智能体始终获得最新上下文。其核心能力包括：一键初始化文档、增量更新、支持多语言项目、可自定义模板与忽略规则，以及将文档输出为智能体易于解析的格式。对于团队协作和长期维护的项目，它显著降低了为 AI 准备上下文的重复劳动。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化，观测越久曲线越完整

数据来源：GitHub API 逐日快照 · 收录于 2026-09-12 · 当前星标 ★ 17700

使用教程

难度：入门约 10 分钟部署方式：命令行工具 5 步

环境要求

Node.js 22 或更新版本
已安装 npm（或 pnpm）等 Node.js 包管理器
Windows 用户请使用 npm/pnpm 安装，不要用 bun
准备一个模型提供商的 API Key（首次运行会引导选择）

安装与启动步骤

1确认 Node 版本

OpenWiki 要求 Node.js 22 或更高版本，先确认本机版本再安装，版本过低需先升级 Node。
```
node -v
```
2全局安装 CLI

通过 npm 全局安装 openwiki 命令行工具。Windows 上建议改用 pnpm，避免 bun 触发原生依赖编译。
```
npm install -g openwiki
```
3初始化生成 wiki

在当前代码仓库目录执行，首次运行会引导你选择模型提供商、填写 Key 和模型，并把文档写入 openwiki/ 目录。
```
openwiki --init
```
4增量更新文档

代码变更后执行，根据上次成功运行以来的仓库变化和过期 Claims 更新已有 wiki，适合日常或 CI 中调用。
```
openwiki --update
```
5配置定时 CI 更新

把仓库 examples 下对应的流水线示例文件放到 CI 配置路径：GitHub Actions、GitLab CI 或 Bitbucket Pipelines，并按需配置密钥。

关键配置

配置项	必填	说明	示例
`openwiki/INSTRUCTIONS.md`	否	用户自行编写的说明文件，重新初始化时会被保留	`openwiki/INSTRUCTIONS.md`
`openwiki/.run.json`	否	持久化检出中记录进行中的仓库生成进度，用于中断续跑	`openwiki/.run.json`
`OPENWIKI_PR_TOKEN`	否	自动合并示例中用于创建 PR 的 GitHub Actions Secret	`ghp_xxxxxxxxxxxxxxxx`

如何确认成功

执行 openwiki --init 完成后，当前仓库下出现 openwiki/ 目录及生成的 Markdown wiki 页面即表示成功。

常见问题

Q：初始化中途被中断了怎么办？

A：在持久化检出中 OpenWiki 会把进行中的生成记录在 openwiki/.run.json，重新执行同一命令即可续跑；CI 临时 runner 失败后则从头开始，除非工作区被保留。

Q：再次执行 openwiki --init 会覆盖已有内容吗？

A：会。它用全新一次生成替换已生成的仓库 wiki 和 Claims，但会保留用户自己写的 openwiki/INSTRUCTIONS.md 说明文件。

Q：Windows 上安装失败怎么办？

A：请用 npm install -g openwiki 或 pnpm add -g openwiki 安装；用 bun 可能回退去编译 better-sqlite3 原生依赖，需要 Visual Studio Build Tools 的 C++ 桌面开发组件。

Q：如何让文档自动保持最新？

A：添加定时 CI 任务：GitHub Actions 复制 openwiki-update.yml 到 .github/workflows/openwiki-update.yml；GitLab 用对应 gitlab-ci 示例；Bitbucket 用 pipelines 示例并调度 openwiki-update 流水线。

注意事项

--init 会替换已有生成内容，但有用户编写的 INSTRUCTIONS.md 会被保留
CI 中途失败会恢复旧 wiki，但临时 runner 上无法续跑
自动合并属于仓库基础设施，需开启 Allow auto-merge 并配置分支保护
自动合并示例必须使用专用 Token（如 OPENWIKI_PR_TOKEN），默认 GITHUB_TOKEN 创建的 PR 不会触发大多数 pull_request 工作流