推出 OpenWiki：一个用于仓库文档的开源智能体

今天，我们发布了 OpenWiki，这是一个用于生成和维护代码库文档的开源智能体与命令行工具。

当智能体理解它们正在工作的仓库时，它们能写出更好的代码。它们需要知道关键逻辑在哪里、文件之间如何连接、以及代码库期望什么样的模式。良好的文档能够为智能体提供这些上下文，从而带来更明智的代码修改，并减少可避免的错误。

问题在于，文档很难保持最新。编写初始文档需要时间，而在代码每次发生变化时更新文档则更加困难。在拥有频繁拉取请求的大型仓库中，文档很快就会过时。

OpenWiki 会自动处理这项工作。它为你的仓库创建一个 Wiki，将该 Wiki 连接到你的编码智能体，并在代码发生变化时保持其更新。

为什么智能体需要 Wiki

我们受到了现有代码库 Wiki 相关工作的启发，包括 DeepWiki、AutoWiki 以及 Karpathy 的 LLM Wiki 概念。其中的核心理念很简单：Wiki 为人类和智能体提供了一种结构化的方式来理解代码库，而无需将所有上下文强制塞进一个巨大的文件中。

这一点很重要，因为大多数编码智能体已经在读取像 AGENTS.md 或 CLAUDE.md 这样的指令文件。这些文件很有用，但它们不是存放数百页仓库文档的合适位置。它们应该引导智能体找到正确的上下文，然后让智能体自行检索所需内容。

OpenWiki 遵循这种模式。它生成一个仓库 Wiki，然后用对该 Wiki 的引用来更新你的智能体指令文件。这样一来，你的编码智能体就能自动发现并使用这些文档。

快速上手

OpenWiki 设计为易于从命令行运行。

使用 NPM 安装：

npm install -g openwiki

然后运行：

openwiki --init

init 命令会要求你提供模型提供商和 API 密钥，然后为你的仓库生成文档。

OpenWiki 支持开放和封闭的模型提供商，包括 OpenRouter、Fireworks、Baseten、OpenAI 和 Anthropic。默认情况下，它使用 OpenRouter 搭配一个开放模型，但你可以配置最适合你环境的提供商。

由于 OpenWiki 构建在 DeepAgents 之上，它也支持向 LangSmith 进行追踪。如果你提供了 LangSmith API 密钥，OpenWiki 会将运行追踪到一个 LangSmith 项目，这样你就可以精确检查智能体在生成或更新文档时做了什么。

OpenWiki 如何连接到你的编码智能体

生成 Wiki 之后，OpenWiki 会更新你仓库的智能体指令文件。如果你的仓库使用了 AGENTS.md、CLAUDE.md 或两者兼有，OpenWiki 会添加对生成 Wiki 的引用，并说明智能体何时应该使用它。

我们选择这种方案是因为将整个 Wiki 放入一个指令文件中会增加太多上下文。在大型仓库中，Wiki 可能包含数百个文件。将所有内容加载到每次智能体运行中既浪费又难以维护。

简短的引用效果更好。你的编码智能体已经在读取指令文件。一旦 OpenWiki 添加了引用，智能体在需要仓库上下文时就能找到 Wiki，而无需你改变工作流程。

保持 Wiki 最新

一次性生成文档是有用的。而保持文档最新则是 OpenWiki 更有价值的地方。

OpenWiki 包含一个 GitHub Action，可以按计划运行，例如每天一次。该 action 使用 update 标志运行 OpenWiki。OpenWiki 会检查自上次运行以来有哪些提交被合并，利用 git diff 了解哪些内容发生了变化，然后用相关上下文更新 Wiki。

这意味着工作流程可以在后台运行。随着你的代码库发生变化，OpenWiki 会更新文档。你的编码智能体通过已有的指令文件引用持续获取最新的 Wiki。

首先为代码库而构建

这第一个版本专注于代码库的 Wiki。目标是让智能体更容易理解它们所工作的仓库，而无需开发者手动编写和维护详细的文档。

随着时间的推移，我们认为 OpenWiki 的概念可以更广泛地应用。智能体在许多类型的工作中都需要持久的上下文，而不仅仅是编码。代码库文档是第一个用例，但同样的模式也可以帮助智能体在其他工作流程中维护有用的上下文。

试试看

OpenWiki 是开源的，现已可用。

你可以安装它，运行 openwiki --init，只需几分钟就能为你的仓库生成一个 Wiki。

查看仓库：https://github.com/langchain-ai/openwiki
观看演示视频：https://youtu.be/nIVu3zfYprI