主题
OpenWiki
编写并维护智能体 wiki 的 CLI,让编码智能体工作得更快
OpenWiki 是一个开源 CLI,用于编写并维护关于你的代码库或个人知识的 Markdown wiki。该 wiki 捕获架构、集成、评估和工作流等细节,以便 编码智能体 可以将其用作持久上下文,而不必在每项任务中重新探索仓库。
这让智能体工作得更快,并在 token 上更省钱:智能体首先阅读经过整理的 wiki,然后只在需要更多细节的地方检查源代码。人类可以浏览相同的 Markdown(以及本地的 可视化工具),但主要受众是智能体。
OpenWiki 构建在 Deep Agents 之上,并支持使用 LangSmith 进行追踪。
开始使用
安装该 CLI,然后为当前仓库初始化文档:
bash
npm install -g openwiki
openwiki --init请参阅 快速入门 以选择模型服务商、生成文档并使其保持最新。如果要在 Codex、Claude Code、OpenCode 或 Cursor 中运行 OpenWiki,而不是在独立的模型会话中运行,请参阅 编码智能体集成。
模式
OpenWiki 有两种模式:
| 模式 | 命令 | 输出 | 何时使用 |
|---|---|---|---|
| 代码(默认) | openwiki / openwiki code | 当前仓库中的 openwiki/ | 你想要为编码智能体提供仓库上下文和文档 |
| 个人 | openwiki personal | ~/.openwiki/wiki | 你想要从配置的来源构建本地个人大脑 |
裸的 openwiki --init 和 openwiki --update 以代码模式运行。使用 openwiki personal --init 或 openwiki personal --update 来操作个人 wiki。
能力
Repository wikis
在 openwiki/ 下生成 Markdown 文档,然后将它们接入 AGENTS.md 和 CLAUDE.md,以便编码智能体可以找到它们。
Coding-agent integrations
使用宿主模型和仓库工具在 Codex、Claude Code、OpenCode 或 Cursor 中运行 OpenWiki。
Personal brain
从 git 仓库、Custom MCP、Gmail、Notion、网络搜索、Hacker News 和 X/Twitter 构建本地 wiki。
Grounded Claims
将重要事实追溯到带版本的源证据,并在该证据发生变化时刷新页面。
Automatic updates
从 GitHub Actions、GitLab CI 或 Bitbucket Pipelines 刷新文档,并在内容变化时打开 PR。
Model providers
开箱即用地使用 OpenAI、Anthropic、Gemini、Bedrock、OpenRouter、GitHub Copilot 以及其他服务商。
Open Knowledge Format
生成带有 front matter、索引和链接概念的 OKF v0.2 Markdown 包。
LangSmith tracing
使用 LangSmith 追踪文档运行。