快速开始

安装 OpenWiki、配置模型服务商，并生成你的第一个 wiki。

OpenWiki 是一个 CLI，可为你的代码库或个人知识编写并维护 Markdown wiki。编码智能体将该 wiki 作为持久上下文，从而花费更少的时间和 token 去重新发现架构、集成以及仓库的其他细节。人类也可以阅读同样的文档，但智能体才是主要受众。本指南涵盖安装、服务商配置以及你的首次文档生成运行。功能概览请参阅 OpenWiki 概览。

安装并生成仓库文档

•Install the CLI

npm install -g openwiki

在 Windows 上，建议使用 npm 或 pnpm。使用 Bun 安装可能会退回到编译原生依赖 better-sqlite3，并可能需要带有「使用 C++ 的桌面开发」工作负载的 Visual Studio Build Tools。

•Initialize in your repository

在仓库根目录下，运行以下命令：

openwiki --init

在首次交互式运行时，OpenWiki 会提示你输入：

• 推理服务商和模型
• 服务商的 API 密钥（或等效凭证）
• 可选的用于追踪的 LangSmith API 密钥
• 用于从运行时追踪中丰富 wiki 的 LangSmith 项目

OpenWiki 会将其配置和密钥保存到 ~/.openwiki/.env。

再次运行 --init 会从头重新生成仓库 wiki 和 Claims，同时保留 openwiki/INSTRUCTIONS.md。在持久化检出上被中断的运行会从 openwiki/.run.json 恢复。

如果想在 Codex、Claude Code、OpenCode 或 Cursor 中运行 OpenWiki，而不是使用独立的模型会话，请参阅 编码智能体集成。

▤Review the generated wiki

OpenWiki 将文档写入仓库中的 openwiki/ 目录，其中包括一个快速入门入口点和若干主题页面。它还会在仓库根目录维护 AGENTS.md 和 CLAUDE.md，并添加一个区块，指示编码智能体查阅该 wiki 以获取代码库上下文。事实性页面则通过 openwiki/.claims/ 下的 Claims 加以佐证。

仓库专属的 wiki 说明位于 openwiki/INSTRUCTIONS.md。OpenWiki 会读取该文件以确定范围和优先级。要更改它，可以编辑该文件，也可以在聊天中让 OpenWiki 修改这份简要说明（例如 openwiki "Update openwiki/INSTRUCTIONS.md to focus on the public API"）。常规的 --init 和 --update 运行不会重写它。

要在浏览器中浏览 wiki，请运行：

openwiki visualize

这会打开一个本地交互式节点图，并配有并排显示的 Markdown 阅读器。请参阅 可视化你的 wiki。

↻Keep docs up to date

代码变更后刷新文档：

openwiki --update

在代码模式下，当源证据发生变化时，更新还会调和过时的 Claims。关于 CI 中的自动化更新，请参阅 自动化更新。

个人 wiki（可选）

要初始化一个本地个人大脑（brain）而不是仓库文档：

openwiki personal --init

个人模式会写入 ~/.openwiki/wiki，并可以摄取已配置的连接器，例如本地 git 仓库、Custom MCP、Gmail、Notion、网络搜索、Hacker News 和 X/Twitter。请参阅 个人模式。

交互式运行与一次性运行

直接运行 openwiki 会为当前仓库以代码模式打开一个交互式会话。传入一条消息即可带着请求启动：

openwiki "Please generate documentation for this repository"

使用 -p / --print 进行一次性非交互式运行，它会打印最终的助手输出并退出：

openwiki -p "Summarize what you can do"

在聊天中，使用 /api-key 更新当前服务商的 API 密钥，使用 /langsmith-key 更新或清除 LangSmith 追踪凭证，并使用 /effort 为受支持的模型设置推理投入程度（reasoning effort）。

使用 LangSmith 追踪

在入门引导过程中，提供一个 LangSmith API 密钥，即可将 OpenWiki 运行追踪到名为 openwiki 的 LangSmith 项目。你也可以在 ~/.openwiki/.env 或进程环境中设置这些值：

LANGSMITH_API_KEY=your-key
LANGCHAIN_TRACING_V2=true
LANGCHAIN_PROJECT=openwiki

要从 LangSmith 追踪中丰富仓库 wiki（与对 OpenWiki 本身的追踪相独立），请参阅 LangSmith 连接器。

后续步骤

• 代码模式：仓库 wiki、Claims、OKF 输出以及智能体说明文件
• 编码智能体集成：在 Codex、Claude Code、OpenCode 或 Cursor 中运行 OpenWiki
• 个人模式：本地大脑与连接器
• 模型服务商：受支持的服务商与凭证
• 自动化更新：GitHub Actions、GitLab CI 和 Bitbucket Pipelines
• CLI 参考：命令与标志

---