langchain-ai/openwiki：README 来源编辑指南

langchain-ai/openwiki 的 README 将项目描述为"OpenWiki is a CLI that writes and maintains agent documentation for your codebase."。本文只整理仓库能直接核验的内容，不把星标、Fork 或宣传语当成质量证明。README 在"The self-maintaining wiki. Built for agents, explored by humans."下的说明是：OpenWiki is a CLI that writes and maintains a wiki for your codebase or your personal knowledge. An agent reads your sources, synthesizes a linked Markdown wiki you own, and keeps it current on every change.。这给出的首先是项目边界，而不是已经完成的生产验证。

从 README 的"The self-maintaining wiki. Built for agents, explored by humans."和相关条目看，读者可以先判断它是否解决自己的具体问题：Two modes: a code wiki for a repository, or a personal wiki for your own knowledge.。如果你的目标与这段说明不一致，就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名，方便回到一手来源核对。 README 还列出了另一条可核对的信息：Agent-written docs that stay accurate, generated by a Deep Agents documentation agent.。这类原文条目可以帮助读者设计试运行步骤，但不能代替自己的环境测试。

README 把工作方式分散写在"Quick start"等段落中。可确认的线索包括：Keep it current automatically by adding a scheduled CI job that opens a docs PR on every change:。这篇整理没有把未写出的架构、性能或安全边界补成结论；真正的运行链仍应结合仓库目录、配置文件和版本标签检查。

第一次安装应从 README 给出的入口开始。当前可复核的命令是： npm install -g openwiki 如果仓库没有提供命令，本文不会替它编造安装步骤，而是建议先打开 README 的"🎉 What's new"部分，确认系统依赖、默认端口和首次初始化动作。

日常使用的细节取决于项目实际文档。README 的"Quick start"段落提到：> [!NOTE] > On Windows, install with a Node.js package manager (npm install -g openwiki or pnpm add -g openwiki). Installing with bun can fall back to compiling the better-sqlite3 native dependency, which needs Visual Studio Build Tools。对于配置文件、环境变量、权限和数据目录，当前稿只记录来源明确的部分；未写明的默认值必须在测试环境中验证，并保留可回滚的配置副本。 同一部分还提到：Twelve model providers out of the box, from OpenAI and Anthropic to Bedrock, Gemini, and any OpenAI-compatible gateway.。