OpenWiki
编写并维护 Agent Wiki 的命令行工具，让编码智能体更快速、更低 Token 成本地理解代码库
OpenWiki 是一款开源 CLI 工具，用于编写和维护关于代码库或个人知识的 Markdown Wiki。该 Wiki 捕获架构设计、外部集成、评测测试和核心工作流等技术细节，使编码智能体能够将其作为持久上下文使用，而无需在每次执行任务时重新把整个仓库遍历一遍。
这让智能体的工作更快速且大幅节省 Token：智能体首先阅读精炼的 Wiki，仅在需要更多实现细节时才定向查看源代码。人类开发者同样可以浏览这些 Markdown（以及本地的可视化器），但其首要目标受众是 AI 编码智能体。
OpenWiki 构建于 Deep Agents 之上，并支持使用 LangSmith 进行链路追踪。
快速起步
安装 CLI，并为当前代码仓库初始化文档：
npm install -g openwiki
openwiki --init请参阅快速起步以选择模型提供商、生成文档并保持文档持续更新。若要在编码智能体内部直接运行 OpenWiki，请参阅编码智能体集成。要检索现有 Wiki 或对相关联的仓库进行分组，请参阅搜索与链接 Wiki。
工作模式
OpenWiki 提供两种工作模式：
| 模式名称 | 运行命令 | 输出路径 | 适用场景 |
|---|---|---|---|
| 代码模式 (Code)（默认） | openwiki / openwiki code | 当前仓库下的 openwiki/ | 为编码智能体生成仓库级架构与技术文档上下文 |
| 个人知识库 (Personal) | openwiki personal | ~/.openwiki/wiki | 从配置的各种来源构建本地个人数字大脑 |
单独执行 openwiki --init 和 openwiki --update 默认以代码模式运行。若要构建个人 Wiki，请使用 openwiki personal --init 或 openwiki personal --update。
核心能力一览
在
openwiki/目录下生成 Markdown 文档，并自动挂载到AGENTS.md（以及存在时的CLAUDE.md）中，以便编码智能体自动发现。
编码智能体集成 (Coding-agent integrations)
在 Codex、Claude Code、Cursor、VS Code、Antigravity 等主流工具内部无缝运行 OpenWiki。
通过 MCP 协议跨服务查询 Wiki 页面，并将多个关联代码仓库的 Wiki 聚合为统一工作区。
从 Git 仓库、自定义 MCP、Gmail、Notion、网络搜索、Hacker News 以及 X/Twitter 构建本地个人 Wiki。
将文档中的事实追溯到带版本号的源码证据，并在该源码证据发生变更时自动提示刷新页面。
在 GitHub Actions、GitLab CI 或 Bitbucket Pipelines 中自动刷新文档，并在内容变更时自动发起 Pull Request。
开箱即用支持 OpenAI、Anthropic、Gemini、Bedrock、OpenRouter 等全球主流模型提供商。
开放知识格式 (Open Knowledge Format)
输出符合 OKF v0.2 标准的 Markdown 资料包，自带 Frontmatter 元数据、索引目录与概念超链接。
LangSmith 链路追踪 (LangSmith tracing)
使用 LangSmith 对文档生成和更新过程进行全链路追踪与调试。
下一步
安装 OpenWiki，配置模型提供商，并生成你的第一个 Agent Wiki。
查阅完整命令、配置标志以及连接器子命令。