YOHO AI

OpenWiki：让 AI 智能体为你的代码库自动写「活文档」的 CLI 工具

作者：

hiyoho

在

OpenWiki

项目简介

OpenWiki 是 LangChain 开源的命令行工具，专为 AI 智能体（Agent）设计，能自动为你的代码库或个人知识源生成并持续维护一份本地 Wiki（知识库）。它把分散在代码、邮件、笔记、社交动态里的信息，用 LLM 合成结构化、可检索、可被编码助手直接引用的文档。

安装要求和过程

环境要求

  • Node.js 运行环境（推荐用 npm 或 pnpm 安装）。Windows 上建议避开 bun——它安装时需要本地编译 better-sqlite3 原生依赖，需先装 Visual Studio Build Tools（桌面开发 with C++ 工作负载）。
  • 至少一个 LLM 提供商的 API Key：开箱支持 OpenAI / Anthropic / Gemini / Vertex AI / AWS Bedrock / OpenRouter / Fireworks / NVIDIA NIM 等，默认模型 gpt-5.6-terra。

快速安装

# 全局安装
npm install -g openwiki
# 或
pnpm add -g openwiki

快速开始

# 代码模式：初始化并配置模型/Key，自动为当前仓库生成文档
openwiki --init

# 进入交互式 CLI，开始生成仓库 Wiki
openwiki

# 带初始指令一次性运行
openwiki "Please generate documentation for this repository"

# 更新文档（可放进 CI 定时跑）
openwiki --update

# 个人大脑模式：从 Gmail/Notion/X 等构建本地知识库
openwiki personal --init

OpenWiki 提供 两种模式：Code 模式为当前代码库在 openwiki/ 生成仓库文档；Personal 模式从配置的本地仓库、Gmail、Notion、Web Search、Hacker News、X/Twitter 在 ~/.openwiki/wiki 构建”个人大脑”。配置与密钥保存在本地 ~/.openwiki/.env。

核心功能

1. 双模式 Wiki：代码库 & 个人大脑

代码模式下，OpenWiki 不仅生成 openwiki/ 目录的仓库文档，还会在仓库根目录维护 AGENTS.md 与 CLAUDE.md；个人模式则把 Git / Notion / Gmail / X / Hacker News / Web 统一 ingested 成一份本地可问答的知识库。

2. 为 Agent 而生：把 Wiki 焊进编码助手

OpenWiki 用 <!-- OPENWIKI:START -->…<!-- OPENWIKI:END --> 注释块向 AGENTS.md / CLAUDE.md 注入指引，且只改写自己的区块、不动你写的内容。结果是 Claude Code、Codex、Cursor 等编码智能体在检索上下文时会直接引用这份 Wiki，而不用把整页代码塞进上下文窗口，显著节省 token。

3. 多连接器 Ingestion

内置 git-repo / gmail / notion / x(Twitter) / web-search(Tavily) / hackernews 连接器，同一连接器可配置多个实例（如 web-search-1、web-search-2），用 openwiki auth <provider> 完成 OAuth 登录。

4. 全模型供应商兼容

开箱支持 OpenAI（含 ChatGPT 订阅登录，免 API 计费）、Anthropic、Gemini（AI Studio）、Gemini Enterprise（Vertex AI）、AWS Bedrock（IAM 凭证）、OpenRouter、Fireworks、Baseten、NVIDIA NIM、以及任意 OpenAI 兼容端点；甚至支持自托管/代理网关的 ANTHROPIC_BASE_URL 与 OPENAI_COMPATIBLE_BASE_URL。

5. CI 自动化 + 隐私友好

提供 GitHub Actions / GitLab CI / Bitbucket 流水线模板，定时自动开 PR 更新文档；数据全部存于本地（本地优先），匿名遥测可一键关闭（OPENWIKI_TELEMETRY_DISABLED=1 或 DO_NOT_TRACK=1）。

典型使用场景

场景一：团队代码库”活文档”

把 openwiki-update.yml 放进 GitHub Actions，每次定时运行自动生成/更新仓库 Wiki 并开 PR。新成员和 AI 编码助手都能秒懂项目结构、模块职责与历史决策，告别”文档写完就过期”。

场景二：个人知识大脑

连接 Gmail、Notion、X、Hacker News 与本地 Git 仓库，OpenWiki 把它们合成一份可问答的本地 Wiki。想回顾某段技术讨论或某封邮件结论时，直接对话即可，知识不再散落各处。

场景三：给编码 Agent 减负

OpenWiki 把 Wiki 注入 AGENTS.md / CLAUDE.md 后，Claude Code 等智能体在动手改代码前会先读 Wiki，避免重复探索、显著降低上下文 token 消耗——这正是”代码库语义化”落地的关键一环。

推荐理由（个人使用心得）

“代码库语义化”是 2026 年 Agent 基础设施里最实在的刚需之一。OpenWiki 的巧思在于：它不只是一个文档生成器，而是把生成的 Wiki 直接焊进 AGENTS.md / CLAUDE.md——这是 Claude Code、Codex、Cursor 都会主动读取的文件。换句话说，它让 AI 编码助手在每次开工前自动带上项目上下文，而不是靠把整页源码塞进上下文窗口。

TypeScript 写的单 CLI、MIT 协议、本地优先、数据不出机器，对个人开发者和注重隐私的团队都很友好；LangChain 出品也意味着模型兼容性与工程质量有保障。唯一的小门槛是需要自备 LLM Key，以及 Windows 上用 bun 装要额外编译原生依赖——用 npm/pnpm 则毫无障碍。如果你已经被”AI 改代码却不懂项目全貌”折磨过，值得一试。

下载地址

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

更多文章