关于 llmwiki
llmwiki 将文档和其他原始资料编译成带引用、互相关联的 Markdown 知识 Wiki,面向需要可复用、可审查知识的 Agent 与团队。它通过配置文件定义类型、关系、审核门槛和工作流,并提供检索、审查、评估及多种导出方式。
主要功能
- 01将来源编译为带引用的关联页面
- 02支持配置生命周期配置文件与模板
- 03混合检索并生成证据包
- 04审核生成页面并追踪引用来源
- 05检查引用、质量与内容新鲜度
- 06提供本地浏览器、CLI 与 SDK
适用场景
- 01将研究论文和笔记整理成可复用 Wiki
- 02为 Agent 提供有来源依据的上下文
- 03审核生成内容后再发布页面
- 04导出知识供其他系统使用
MCP 相关
`llmwiki serve` 将摄取、编译、查询、检查、读取、状态、评估、上下文包和 OKF 交换等工具提供给兼容 MCP 的 Agent。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
16收录的工具列表 · 更新于 1 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| source | string | 是 | URL(http/https)或 .md/.txt 文件的绝对路径 |
详细介绍
llmwiki
1.5 新功能 — Wiki 行为与存储分离。
1.5.0 是 npm latest 上的稳定版本:npm install --global llm-wiki-compiler。
- 同一个 Wiki,更简洁的基础架构。 编译、检索和审核现在会描述它们对存储的需求,而不是直接操作文件。现有 Wiki 保持原有布局,照常运行,无需迁移。
- Converse 网关。 使用经过 bearer 身份验证的 Converse 端点作为提供方。
- 与来源相匹配的页面。
llmwiki compile --no-pages-limit可取消固定的概念数量限制。 - 及时更新的查看器。
llmwiki view会在编译后刷新,无需重启,并从LLMWIKI_VIEW_PORT读取端口。
1.4 新功能 — 发布前审核答案。
在生成的答案成为页面之前,先审核答案及其引用;一次操作即可批准一批页面;还可追溯答案所依据的页面。发行说明 · 升级指南
1.3 新功能 — 为 Wiki 焕然一新。
认识一下 Scientific Clay:柔和的表面与圆润的字体;还有 Minimal,它会遵循系统的浅色或深色设置。可在四种主题间即时切换,包括 Nebula Light 和 Dark。
| Scientific Clay | Minimal |
|---|---|
![]() | ![]() |
这是演示 Wiki 中的同一页面。点击任一截图可放大查看。
支持递归来源文件夹、路径排除、项目专属编译说明,以及用于更大嵌入索引的存储。
1.2 新功能 — 探索记录及其依据。
在本地查看器中浏览由配置文件定义的类别、声明字段、关联记录、来源信息和支持性来源段落。
1.1 新功能 — 发布和分享领域模板。
创建经过签名的模板分发包,通过明确受信任的目录发现模板,并在兼容性检查后安装或更新模板。
1.0 新功能 — 可配置的生命周期配置文件。
围绕你的工作方式构建知识系统。 在一个经过验证的配置文件中定义记录、关系、审核关卡和工作流。可从用于研究的 AutoSci 或用于编辑工作的 Newsroom 开始,也可以创建自己的配置文件。
llmwiki 的功能
将原始资料编译为相互链接、可追溯引用的 Markdown 知识库,供 Agent 和人类浏览、查询、检查、导出和复用。默认配置保留经典的「概念与查询」布局;可选配置可添加特定领域的类型和工作流,而无需在编译器中添加领域分支。
llmwiki 实现了 LLM Wiki 模式:不必在查询时从原始文件中重新发现知识,而是一次性将其编译为持久页面,让页面随着时间推移不断积累结构、来源信息、审核状态和检索元数据。
何时使用此仓库
需要根据原始资料构建持久知识库时,请使用 llmwiki:
- 将论文、笔记、README、转录文本、PDF、图像或网页编译为类型明确的知识库页面。
- 为 Agent 提供稳定且支持引用的上下文包,而不是一堆零散文件。
- 通过来源引用、审核队列、新鲜度检查和质量门禁,确保生成的知识可审计。
- 在本地浏览结果,通过 CLI 查询,通过 MCP 提供服务,或通过 SDK 嵌入。
- 使用 Open Knowledge Format(OKF)、JSON、JSON-LD、GraphML、Marp 和
llms.txt与其他工具交换编译后的知识。
不要将 llmwiki 用作通用静态网站生成器、复杂的本体数据库,也不要用它替代对快速变化的原始日志进行临时搜索。当值得编译、审核和复用来源知识时,llmwiki 最能发挥作用。
你将获得什么
- 编译后的 Wiki,而非内容块。 两阶段大模型流水线先提取概念,再生成类型化页面:
concept、entity、comparison和overview。 - 可配置的生命周期配置。 采用 fail-closed 机制的
.llmwiki/profile.json可声明实体模式、类型化关系、生命周期状态机、状态转换要求、工作流、制品、连接器、内容层级和检索策略。 - 可安装的领域模板。
llmwiki template init autosci会创建一个研究项目,包含论文、创意、实验、手稿、证据制品、工作流和 Crossref 导入。newsroom则展示了同一套机制在编辑工作中的应用。 - 运行时信任关卡。 关系、证据、制品以及人工/Agent 关卡由写入路径强制执行,而非仅作为提示词约定;持续运行的 lint 会在事后检测偏差。
- 可追溯引用的输出。 段落和论断会引用源文件及行范围,
llmwiki lint会验证这些链接。 - 混合检索。 语义内容块搜索、BM25 重排序和 Wiki 链接图扩展会为查询和 Agent 构建精简的证据包。
- 本地查看器。
llmwiki view会打开只读浏览器 UI,提供搜索、页面元数据、图谱探索、源文件新鲜度徽标和引用标记。 - 审核策略。 当置信度、矛盾、模式或来源规则触发时,生成的页面可自动暂存以供审核。
- 新鲜度修复。
llmwiki lint和llmwiki next会标出过时或孤立的页面;llmwiki refresh --stale会修复变更的知识,而不编译无关的新来源。 - 评测工具。
llmwiki eval会报告健康评分、标出最差页面的逐页健康度分布、Wiki 链接图健康状况、引用覆盖率/精确率、语料库统计、回归差异,以及可选的裁判模型引用支持度。 - MCP 服务。
llmwiki serve会向兼容 MCP 的 Agent 暴露 ingest、compile、query、lint、read、status、eval、context-pack 和 OKF exchange 工具。 - SDK。
createWiki({ root })可在不调用 shell 命令的情况下,通过 TypeScript 驱动 ingest、compile、query、context、status、export、eval 和 OKF import/export。 - Open Knowledge Format 交换。 导出和导入 OKF 包,实现可移植、以 Markdown 为原生格式的知识交换。默认情况下,外部 OKF 导入内容会经由审核队列暂存;也可显式将可信包直接写入正式库。
- 其他可移植导出格式。 可导出 JSON、JSON-LD、GraphML、Marp 幻灯片和
llms.txt,供下游系统使用。 - 跨提供商支持。 支持 Anthropic、Claude Agent SDK 本地登录、OpenAI Codex CLI 本地登录、OpenAI 兼容服务、Ollama、GitHub Copilot、Atlas Cloud、OrcaRouter、兼容 Converse 的网关,以及本地 OpenAI 兼容运行时。
可配置生命周期配置文件(CLP)
CLP 将 llmwiki 的知识编译器转化为可复用的基础,用于构建特定领域的知识系统。经过验证的 .llmwiki/profile.json 是以下内容的统一契约:
- 类型化实体、字段和有向关系;
- 生命周期状态、转换证据和信任关卡;
- 多阶段工作流和已声明的操作;
- 固定哈希的构件和一方连接器绑定;以及
- 内容层级和检索行为。
这些规则由运行时强制执行,而不是留作提示词约定。CLI、SDK、MCP 服务、查看器、上下文构建器、lint、状态、导出和 OKF 交换界面都基于同一配置文件契约运行。无效配置文件以及绕过已声明关卡的写入都会被拒绝。
CLP 在设计上向后兼容:没有 .llmwiki/profile.json 的项目会使用内置的默认概念与查询配置文件,并保留 1.0 之前的行为。你可以通过三种方式开始——搭建自己的配置文件、安装内置或本地模板,或从可信 tap 安装签名模板:
# author your own profile, one entity type at a time
llmwiki profile init research --entity paper
# or install a built-in or local declarative template
llmwiki template list
llmwiki template inspect autosci
llmwiki template init autosci
llmwiki profile validate
llmwiki workflow list
autosci 是一个实用的研究系统,包含论文、想法、实验、手稿、证据构件、工作流和 Crossref 导入功能。newsroom 将相同的通用机制应用于文章、编辑部、署名和编辑工作流。模板仅包含配置和示例,不包含可执行插件代码。
模板也可以安全地分发。发布者使用 llmwiki template publish 构建签名的离线分发包,支持 Ed25519 签名、密钥轮换和软件包撤销,并使用 template publish verify 进行验证。使用者可添加明确受信任的 tap、发现并检查签名目录,以及安装或更新模板;系统会在锁定状态下强制执行连续性、撤销和兼容性检查。
阅读 CLP 概念指南,参阅 AutoSci 研究工作流,或探索 Newsroom 编辑工作流。
Karpathy 的 LLM Wiki 模式
Andrej Karpathy 将 LLM Wiki 模式描述为一种将原始材料转化为已编译知识的方法,让未来的 Agent 能够复用这些知识。llmwiki 是这一模式的具体编译器。
关键转变是将工作从查询时移至编译时。传统 RAG 会反复检索原始文本块,并要求模型针对每个问题重新构建关系。llmwiki 则先将来源转化为带有引用、元数据和审核状态的类型化互联页面。随后,查询、上下文包、导出和 MCP 工具都基于这些已编译的构件运行。
因此,当知识需要不断积累时,llmwiki 就很有用:多个来源中共享的概念会整合为一个页面,保存的答案会成为未来的上下文,可以检测并修复过时页面,而 Agent 可以使用稳定的证据包,而不必每次都从头重读相同的原始文件。
有关更深入的说明,请参阅 docs/concepts/karpathy-pattern.mdx。
Agent 决策指南
如果你需要一套可复用的文档、研究资料或项目知识语料库,请使用 llmwiki。
如果需要证据来支持自己的推理,请从 wiki_status 和 get_context_pack 开始。
单次读取文件或实时网页搜索不需要使用 wiki。
npm 包包含一个 Agent 技能。安装说明请参阅
MCP 设置指南。
MCP Registry 标识符为 io.github.atomicstrata/llmwiki;npm 包名为
llm-wiki-compiler,可执行文件为 llmwiki。
选择与任务相符的入口:
| 目标 | 使用 |
|---|---|
| 从一个来源创建 wiki 并进行检查 | llmwiki quickstart <source> |
| 启动类型化研究或编辑项目 | llmwiki template list,然后运行 llmwiki template init autosci|newsroom |
| 检查或验证当前域契约 | llmwiki profile show 和 llmwiki profile validate |
| 运行已声明的生命周期工作流 | llmwiki workflow list,然后运行 llmwiki workflow start <id> |
| 编写或验证由配置文件声明的产物 | llmwiki artifact write ... 和 llmwiki artifact verify <ref> |
| 通过连接器导入外部记录 | llmwiki connector list,然后运行 llmwiki connector run <id> --input key=value |
| 添加更多文件或 URL | llmwiki ingest <url-or-file> |
| 编译或重新编译已更改的来源 | llmwiki compile |
| 添加项目专属的写作指南 | llmwiki compile --instructions ./SOUL.md;每次按指南编译时都要传入此选项 |
| 移除错误的来源及其衍生页面 | llmwiki rm <source> |
| 暂缓生成页面,等待人工审批 | llmwiki compile --review 或审核策略配置 |
| 提出有依据的问题 | llmwiki query "question" |
| 将回答保存回 wiki | llmwiki query "question" --save |
| 为另一个 Agent 构建证据包 | llmwiki context "<task>" --json 或 MCP get_context_pack |
| 检查已编译的知识库 | llmwiki view --open |
| 检查断开的链接、引文、可信度、时效性和质量 | llmwiki lint 和 llmwiki eval |
| 修复过时的已编译页面 | llmwiki refresh --stale --dry-run,然后运行 llmwiki refresh --stale |
| 通过 Agent 驱动 llmwiki | llmwiki serve --root <project> |
| 通过 TypeScript 驱动 llmwiki | createWiki({ root }) |
| 导出到其他系统 | llmwiki export --target <format> |
| 导出 Open Knowledge Format 捆绑包 | llmwiki export --target okf --out <dir> |
| 导入 Open Knowledge Format 捆绑包 | llmwiki import --okf <dir> --dry-run,然后审核/批准 |
快速开始
npm install -g llm-wiki-compiler
export ANTHROPIC_API_KEY=sk-...
# or choose another provider:
# export LLMWIKI_PROVIDER=openai
# export OPENAI_API_KEY=sk-...
llmwiki quickstart ./notes.md
llmwiki query "what are the key ideas?"
llmwiki view --open
quickstart 会摄取一个来源、编译页面并打开查看器。在现有项目中,如果需要最稳妥的下一步操作,请运行 llmwiki next。
若要从域模型开始,而非使用默认的概念与查询布局:
mkdir research-wiki && cd research-wiki
llmwiki template inspect autosci
llmwiki template init autosci
llmwiki profile validate
llmwiki workflow list
模板安装适用于新的或空的类型化项目。它会将所选配置文件写入 .llmwiki/profile.json;正常加载项目时不会依赖模板注册表或锁文件。
演示
可使用任意文章或文档试用:
mkdir my-wiki && cd my-wiki
llmwiki quickstart https://en.wikipedia.org/wiki/Andrej_Karpathy
llmwiki query "What terms did Andrej coin?"
examples/basic/ 目录中包含一个预先生成的小型 wiki,无需 API 密钥即可查看。
核心命令
| 命令 | 功能 |
|---|---|
llmwiki ingest <url-or-file> | 获取 URL 内容,或将本地文件复制到 sources/。 |
llmwiki ingest-session <path> | 将导出的 Claude、Codex 或 Cursor 会话导入 sources/。 |
llmwiki quickstart <source> | 一步完成导入、编译,并可选择打开查看器。 |
llmwiki compile | 增量提取概念并生成 Wiki 页面。 |
llmwiki rm <source> [--dry-run] | 删除来源,以及仅由该来源派生的概念页面。 |
llmwiki refresh --stale [--dry-run] | 重新编译过时页面的已更改所有者,并清理选定的孤立所有权。 |
llmwiki template list|inspect|init | 查找并安装经过验证的声明式配置模板。 |
llmwiki profile init|show|validate|diff | 创建最小配置文件、检查配置文件、验证配置文件,或评估配置文件的更改。 |
llmwiki workflow ... | 查找并驱动配置文件声明的工作流、阶段、关卡和输出;在各次调用间保留运行状态。 |
llmwiki artifact write|verify | 写入可信的配置文件声明的制品,并验证固定哈希的引用。 |
llmwiki connector list|run | 查找第一方连接器,并暂存外部记录以供审核。 |
llmwiki review list/show/approve/reject | 检查并管理暂存的候选项。 |
llmwiki query "question" [--save] | 针对已编译的 Wiki 提问,并可选择保存答案。 |
llmwiki context "<prompt>" --json | 为 Agent 构建带引用的证据包。 |
llmwiki view [--open] | 启动只读的本地浏览器查看器。 |
llmwiki status [--json] | 报告页面和来源数量、过时和孤立页面、待处理工作以及状态健康情况。 |
llmwiki lint | 验证 Wiki 的结构、引用、链接、元数据和时效性。 |
llmwiki eval [--suite fast|full] | 衡量 Wiki 质量和可选的引用支持情况。 |
llmwiki export --target <format> | 将 Wiki 导出为可移植格式,包括 Open Knowledge Format(okf)。 |
llmwiki import --okf <dir> [--dry-run] [--trusted] | 导入 Open Knowledge Format 包;默认暂存以供审核。 |
llmwiki serve --root <dir> | 启动 MCP 服务。 |
完整的命令文档位于 docs/cli/。
Open Knowledge Format
llmwiki 是 Open Knowledge Format(OKF)的生产者和使用者。OKF 是 Google Cloud 发起的一项计划,用于通过带结构化 frontmatter 的可移植 Markdown 文件分享编译后的知识。
llmwiki export --target okf --out ./dist/okf
llmwiki import --okf ./dist/okf --dry-run
llmwiki import --okf ./dist/okf
OKF 导入有意采用先审核的流程:不可信的包会成为审核候选项,而不是直接成为生效的 Wiki 页面。导入器会保留外部 OKF 元数据,将 llmwiki 来源信息存储在 x-llmwiki 下,并在本地编辑后如实重新导出导入的页面,包括安全保留原始嵌套路径。
请参阅 docs/guides/open-knowledge-format.mdx、docs/cli/export.mdx 和 docs/cli/import.mdx。
llmwiki 会创建什么
项目包含 sources/ 中的原始输入、wiki/ 中编译后的 Markdown,以及 .llmwiki/ 下的编译器状态:
sources/
raw source files
wiki/
concepts/ compiled pages
queries/ saved answers
<entity>/ profile-declared typed pages
graph/ typed relation and audit-event stores
outputs/ derived workflow projections
index.md generated TOC
.llmwiki/
profile.json active domain contract
template-lock.json advisory install provenance
config.json review policy and source selection
schema.json page-kind/cross-link policy
state.json source hashes and ownership
candidates/ held review candidates
workflows/ signed workflow run state
eval/ quality history and thresholds
artifacts/ hash-pinned profile-declared files and manifests
log.md activity journal
编译后的页面是普通 Markdown,带有 YAML frontmatter,以及足够的元数据,供 Agent 判断引用、时效性、置信度、矛盾和审核状态。请参阅 docs/concepts/wiki-model.mdx。
默认情况下,来源是顶层 Markdown 文件。可在项目配置中启用嵌套来源文件夹和排除规则。排除已编译的来源后,下次常规编译时会撤销该来源的贡献,但不会删除来源文件。
Agent 集成
MCP
运行:
llmwiki serve --root /path/to/wiki-project
MCP 客户端可以接入来源、编译、查询、搜索页面、读取页面、运行 lint、运行 eval、检查状态、请求上下文包,以及交换 OKF 包。只读工具无需提供商凭据即可使用;由大模型驱动的工具会在调用时验证提供商凭据。run_eval 工具无需提供商即可运行快速套件;其完整套件(会使用大模型评判引用支持情况)则需要提供商。
参见 docs/guides/mcp-agent-integration.mdx。
SDK
import { createWiki } from "llm-wiki-compiler";
const wiki = createWiki({ root: "/path/to/wiki-project" });
await wiki.ingest({ source: "./notes.md" });
await wiki.compile();
const answer = await wiki.query({ question: "What changed?" });
参见 docs/guides/sdk.mdx。llm-wiki-compiler 是受支持的入口;其作用范围明确的配套包属于实现依赖。本地工作流引擎与应用自身的协调器是两个层级,并非迁移路径:llmwiki workflow 会通过本地调用运行由配置文件声明的工作流,并在会话之间持久化状态。外部协调器调用相同的 SDK,但不会使用本地工作流执行方法;配套引擎依赖仍会安装。参见 SDK 包选择、
SDK 升级说明以及
何时使用本地引擎。
配置
最低要求:Node.js 24 或更高版本。
默认提供商为 Anthropic:
export ANTHROPIC_API_KEY=sk-...
提供商由环境变量选择:
| 提供商 | 典型配置 |
|---|---|
| Anthropic | ANTHROPIC_API_KEY 或 ANTHROPIC_AUTH_TOKEN |
| Claude Agent SDK | 本地 Claude Code 登录,LLMWIKI_PROVIDER=claude-agent |
| OpenAI Codex CLI | 本地 Codex 登录 / ChatGPT 订阅,LLMWIKI_PROVIDER=codex-agent;需要显式指定嵌入提供商 |
| OpenAI-compatible | LLMWIKI_PROVIDER=openai、OPENAI_API_KEY,可选 OPENAI_BASE_URL |
| Converse-compatible gateway | LLMWIKI_PROVIDER=converse、显式指定 LLMWIKI_MODEL、LLMWIKI_CONVERSE_BASE_URL 和 LLMWIKI_CONVERSE_API_KEY;启用时需要单独指定嵌入提供商 |
| Ollama | LLMWIKI_PROVIDER=ollama、OLLAMA_HOST |
| GitHub Copilot | LLMWIKI_PROVIDER=copilot、GITHUB_TOKEN=$(gh auth token) |
| Atlas Cloud | LLMWIKI_PROVIDER=atlascloud、ATLASCLOUD_API_KEY |
| OrcaRouter | LLMWIKI_PROVIDER=orcarouter、ORCAROUTER_API_KEY |
参见 docs/configuration/providers.mdx 和 docs/configuration/environment-variables.mdx。
质量与安全模型
llmwiki 专为可审计的生成式知识而设计:
- 写入前先审核。 使用
compile --review或.llmwiki/config.json中的审核策略,将有风险的页面暂存为候选项。 - 配置档案的最低要求会在运行时检查。 页面、生命周期、工作流、导入和审批等写入途径都会强制检查字段契约、生命周期转换、关联数量、证据和构件要求。
- 外部连接器数据不可信。 第一方连接器会使用受限抓取,并暂存带有围栏标记的审核候选项;审批会固定到操作员审核过的确切正文。
- 构件是内容寻址的证据。 构件的读取和写入受路径限制、大小上限和架构检查约束,并会根据固定哈希的引用进行验证。
- 配置失败时安全关闭。 审核策略配置无效时会中止编译,而不会静默禁用审核。
- 来源限制。 来源片段以及导入/导出路径均限制在项目范围内。
- 明确标示新鲜度。 页面可处于新鲜、过时、孤立或未经验证状态;过时页面会被标记,并可修复。JSON 导出仅包含活动页面:它会携带在线页面的新鲜度(
fresh/stale/unverified);计算得出的孤立页面(所有来源均已删除)只会显示为 lint 和查看器信号,不会包含在导出中。 - 默认暂存导入的编译知识。 外部包会进入审核队列,除非明确标记为可信。
- 支持 CI 门禁。
llmwiki lint和llmwiki eval可强制执行质量阈值。
请参阅 docs/configuration/review-policy.mdx、docs/troubleshooting/stale-pages.mdx 和 docs/guides/ci-quality-gates.mdx。
规模与适用场景
llmwiki 仍处于早期阶段,但已不再是只能处理少量笔记的玩具流水线。
- 增量编译意味着未更改的来源不会再次经过大模型处理。
- 并行编译会在可配置的上限内(
--concurrency/LLMWIKI_COMPILE_CONCURRENCY)并发执行概念提取和页面生成,缩短大型编译的总耗时。 - 分块级嵌入会在 BM25 重排序和图扩展之前缩小大型 wiki 的检索范围。
- 感知内容哈希的嵌入更新可避免为未更改的页面和分块重新计算向量。
- 批量嵌入会将页面和分块向量分批发送给提供方,而不是每次只发一个请求,从而减少冷启动和大规模刷新时的延迟。
- 二进制嵌入存储会自动处理超过 64 MiB JSON 限制的存储;较小的存储也可选择启用。二进制存储选择会持久保留,检索时仍会将索引加载到内存中。请参阅限制、恢复和降级指南。
- 缓存的引用判断可降低重复运行
eval --suite full的成本。 - 词法回退可在当前提供方没有嵌入端点时,继续支持查询/上下文工作流。
- 提示词预算和摄取截断元数据会明确标示大型来源,而不是悄悄假装它们能够完整容纳。
目前最适合将其用于持久的项目或领域 wiki:研究文件夹、代码库文档、团队手册、标准、设计笔记、决策日志或精选来源包。不太适合的场景是高频变化的信息流:原始搜索已经足够,而编译后的结构可能还没来得及审核就已过时。
文档
完整的文档站点源码位于 docs/:
- 从这里开始:
docs/introduction.mdx - 快速入门:
docs/quickstart.mdx - 安装:
docs/installation.mdx - Karpathy 的 LLM Wiki 模式:
docs/concepts/karpathy-pattern.mdx - 编译器的工作原理:
docs/concepts/how-it-works.mdx - Wiki 模型:
docs/concepts/wiki-model.mdx - 可配置的生命周期配置:
docs/concepts/configurable-lifecycle-profiles.mdx - AutoSci 研究工作流:
docs/guides/autosci-research-workflow.mdx - Newsroom 编辑工作流:
docs/guides/newsroom-editorial-workflow.mdx - 配置模板:
docs/configuration/profile-templates.mdx - CLI 参考:
docs/cli/ - 开放知识格式:
docs/guides/open-knowledge-format.mdx - MCP 集成:
docs/guides/mcp-agent-integration.mdx - SDK:
docs/guides/sdk.mdx - SDK 包和升级说明:
docs/guides/sdk-packages.mdx、docs/guides/sdk-upgrade.mdx - 架构和所有权边界:
ARCHITECTURE.md - Atomic Memory 桥接:
docs/guides/atomic-memory-bridge.mdx
使用 Node 24 在本地预览文档:
cd docs
volta run --node 24 npx mint dev --port 3001
当前版本
稳定版本 1.5.0: 当前 npm latest dist-tag 指向的版本。它包含与 1.5.0-rc.1 候选版本相同的代码。
- Wiki 行为与本地文件 I/O 分离。 决定 Wiki 行为的代码,例如哪些来源已更改、页面链接到什么内容,或审核候选项是否可以获批,过去会直接打开、锁定和重命名文件。现在,这些规则通过专门的存储边界运行,而当前的本地磁盘布局是它们的首个实现。锁定、原子写入、路径限制、符号链接处理和恢复逻辑仍由本地实现负责。对你而言,没有任何变化:目录布局、文件格式、默认设置以及 CLI、SDK 和 MCP 入口都保持不变,无需迁移或设置存储选项。这项工作为替代存储以及独立于磁盘测试 Wiki 逻辑奠定基础;它不会增加托管存储、远程后端、基于角色的权限或公开的存储插件 API。请参阅
ARCHITECTURE.md。 - Converse 网关提供方。
LLMWIKI_PROVIDER=converse可连接到使用 bearer 身份验证且支持 Converse 协议的端点,并支持流式传输和结构化提取。其 AWS 协议包为可选项,只有选择该提供方时才会加载。请参阅提供方设置。 --no-pages-limit提取。llmwiki compile --no-pages-limit会取消每个来源需提取 3–8 个概念的要求,因此来源会生成其内容所支持的页面。- 查看器刷新和端口。
llmwiki view会在编译后于后台重建快照,关闭时会干净地停止刷新;若未指定--port,则会读取LLMWIKI_VIEW_PORT。 - 正确性修复。 提取出的概念名称中的 Wiki 链接标记不再导致创建重复页面,GPT-6 Luna 模型也可与 OpenAI 提供方配合使用。MCP Wiki 工具会避免将进度输出写入标准 I/O 协议流,且
sources/中的命名管道不再导致新鲜度检查挂起。 - 提示词版本
v7。 每个新生成的页面都会记录提示词版本v7,包括默认运行生成的页面。仅升级版本不会重新编译未更改的来源。
npm install --global llm-wiki-compiler
配套软件包已固定为相同版本,并会随之安装。MCP Registry 条目 io.github.atomicstrata/llmwiki 会在 npm 发布后以 1.5.0 发布。现有项目无需迁移;请阅读升级说明,了解提示词版本变更和可选的 Converse 依赖项。
已发布 1.4.2: 修复了使用 codex-agent 提供程序时 llmwiki compile 的问题,并包含 1.4.0 的功能:发布前审核答案、批量审批、重复使用提取结果、页面级答案引用,以及带有匹配配套依赖项的拆分式 SDK。
实验性制品类型和工作流状态可能需要更新源代码;从 1.3 升级前,请阅读 SDK 升级说明。请参阅 1.4.0 版本摘要和更新日志,了解迁移详情、贡献者鸣谢和限制。
已发布 1.3.0:
- 四种查看器主题,Scientific Clay 成为新的默认主题,Minimal 会沿用系统设置。已保存的浅色/深色偏好会迁移为 Nebula Light/Dark。
- 递归发现源文件、按字面匹配路径进行排除,以及明确的项目专属编译说明。
- 用于较大嵌入索引的有界二进制存储、可配置的补全预算,以及受保护的网关请求扩展。
- OrcaRouter 嵌入路由、可重试的规则语言变更,以及公开的测试类型检查门槛。
请参阅 1.3.0 版本摘要和更新日志,了解迁移详情、贡献者鸣谢和限制。
已发布 1.2.0:
- 支持配置文件的查看器,包含文档类别、记录关系、来源信息、源文件预览、经过验证的本地制品访问、响应式导航和自适应图表。
- 更多提供程序、OpenAI 兼容的推理模型控制、独立的嵌入配置,以及可选择停用 SDK 嵌入功能。
- 可选的 Sources 部分,以及支持附加的 SDK 系统策略,包含提示词变更失效机制和逐页来源信息。
- 移除源文件后的共享页面恢复、引用行列表修复,以及保守的缩写式维基链接修复。
此版本包含 Windows 路径修复,但原生 Windows 验证和 CI 仍未完成。Windows 上的完整文件系统隔离保证尚未验证。对于不受信任的项目,请使用受支持的 Linux 环境;请参阅 #217。
已发布 1.1.0:
- 模板分发生态:发布者可通过
template publish init | add | build | rotate | revoke创建签名的离线分发包(Ed25519 签名、密钥轮换、软件包撤销),并使用template publish verify对其进行验证。 - 使用者可明确配置受信任的模板源,发现并检查已签名的目录,并在锁定状态下通过连续性、撤销和兼容性检查来安装或更新模板。
llmwiki status命令:提供易读的快照,显示页面和源文件数量、上次编译时间、过期和孤立页面、待处理变更、审核队列、活动配置文件以及状态文件健康情况。
已发布 1.0.0:
- CLI、SDK、MCP、查看器、上下文、lint、状态、导出以及支持配置文件的 OKF 交换中均可配置生命周期配置文件。
- 内置
autosci和newsroom模板、类型化工作流和操作、一等制品、类型化关系和运行时生命周期门控,以及经强化的第一方连接器基础设施(含 Crossref)。 - 类型化页面语义搜索和检索控制、批量嵌入、并行编译,以及失败时关闭的状态恢复机制。
请参阅 CHANGELOG.md 查看版本历史。
配套项目:Atomic Memory
llmwiki 和 Atomic Memory 是互补的开放上下文基础设施:
- llmwiki 将源材料编译为持久、可检查的知识。
- Atomic Memory 为 Agent 提供可搜索、可限定范围、可纠正且可检查的运行时记忆。
可以单独使用,也可以搭配使用。@atomicmemory/llmwiki 桥接工具会将 llmwiki export --target json --project-id <id> 导入为持久记忆记录。
贡献
欢迎贡献。如果 llmwiki 缺少你需要的功能,请提交 issue 或 PR,并描述你希望支持的工作流——由需求驱动的改进往往效果最好。如果你想参与更广泛的贡献,可以从路线图项目入手。对于涉及核心编译、审查、导入/导出或检索语义的较大改动,请先提交 issue 或发起设计讨论,以便我们先对接口约定达成一致。
提交代码更改前,请运行:
npx tsc --noEmit
npm run build
npm test
npm run fallow:ci
请参阅 CONTRIBUTING.md。
许可证
MIT
免责声明
制作此代码库的过程中,没有 LLM 受到伤害。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。

