llm-wiki-compiler新手教程：quickstart一条命令从0到1编译知识Wiki（含本地viewer可视化浏览）

llm-wiki-compiler新手教程：quickstart一条命令从0到1编译知识Wiki（含本地viewer可视化浏览）

【免费下载链接】llm-wiki-compilerThe knowledge compiler. Raw sources in, interlinked wiki out. Inspired by Karpathy's LLM Wiki pattern.项目地址: https://gitcode.com/gh_mirrors/ll/llm-wiki-compiler

llm-wiki-compiler（命令行程序名为llmwiki）是一款开源的知识编译器：把原始资料（网页、笔记、PDF 等）"编译"成一个带引用、带互链的 Markdown 知识 Wiki，并提供本地 viewer 可视化浏览。本教程面向新手，用一条llmwiki quickstart命令带你从 0 到 1 编译出第一个知识 Wiki，再用本地 viewer 直观看到成果 🚀

为什么需要"知识编译器"？

你可能有这样的痛点：知识散落在一堆文档、文章和笔记里，找起来全靠记忆。传统的做法是每次都让 AI 重新读一遍原始文件，既慢又贵。

llm-wiki-compiler 的思路来自 Karpathy 提出的 LLM Wiki 模式：把知识一次性"编译"成持久页面，而不是查询时反复重读原始文件。编译后的 Wiki 具有以下特点：

• ✅互链页面：每个概念一页，页面间用[[wikilinks]]互相引用
• ✅引用可溯源：段落级别标注来源文件和行号
• ✅增量编译：只重新处理有变化的来源，节省时间和 API 费用
• ✅多形态消费：命令行查询、本地 viewer 浏览、MCP 接入 AI 工具、导出多种格式

更多设计原理可阅读 docs/concepts/how-it-works.mdx。

开始前的3步安装（2分钟搞定）

1️⃣ 确认 Node.js 版本

llmwiki 要求Node.js ≥ 24，运行node --version检查版本，低于 24 请先到 nodejs.org 或用 nvm/fnm 升级。

2️⃣ 全局安装 llm-wiki-compiler

npm install -g llm-wiki-compiler

安装完成后会注册llmwiki命令，可用llmwiki --version验证。完整安装说明见 docs/installation.mdx。

3️⃣ 配置一个 LLM 服务商

编译和查询需要调用大模型，默认使用 Anthropic：

export ANTHROPIC_API_KEY=sk-...

也支持 OpenAI 兼容接口、Ollama、GitHub Copilot、Claude Agent SDK 等多种服务商，全部配置项见 docs/configuration/providers.mdx。把配置写进项目目录的.env文件也可以自动加载。

核心步骤：quickstart一条命令从0到1

现在进入高潮部分。创建一个新目录，一条命令搞定「导入来源 → LLM 编译 → 打开浏览器」全流程：

mkdir my-wiki && cd my-wiki llmwiki quickstart ./notes.md

quickstart接受任意支持的来源：本地 Markdown 文件、PDF、甚至一个 URL。例如用一篇维基百科文章试试：

llmwiki quickstart https://en.wikipedia.org/wiki/Andrej_Karpathy

编译成功后，你会看到类似这样的输出：

1. Ingested source → sources/andrej-karpathy.md 2. Compiled wiki → 8 new, 0 skipped Viewer ready at http://127.0.0.1:3000

一条命令，1 个来源进去，8 个互链概念页出来 ✨

几个常用参数：

• --no-open：只编译，不自动打开浏览器
• --review：生成的页面先放进审核队列，人工批准后才写入 Wiki
• --concurrency <n>：调高编译时并发的 LLM 调用数（默认 5）

完整命令参考在 docs/quickstart.mdx 和 docs/cli/ 目录。

编译出来的Wiki长什么样？

llmwiki 会在项目目录里生成这样的结构：

sources/ ← 原始来源文件 wiki/ concepts/ ← LLM 提取的概念页（带 YAML 元数据） index.md ← 自动生成的目录 .llmwiki/ ← 编译器状态（哈希、所有权、配置） log.md ← 活动日志

想看真实产出？仓库里有一个无需 API key 的预生成示例 examples/basic/：1 篇文档进去，7 个互链概念页出来。其中 examples/basic/wiki/concepts/knowledge-compilation.md 就是一个典型的编译产物——带元数据 frontmatter、来源归属和时间戳的结构化页面。

用自然语言查询你的Wiki

编译完成后，直接提问即可，llmwiki 会用语义检索 + BM25 重排 + 图谱扩展给出有据可依的回答：

llmwiki query "什么概念是这篇笔记独有的？"

满意的答案可以保存回 Wiki，成为未来查询的上下文，让知识"复利"增长：

llmwiki query "知识编译的核心流程是什么？" --save

命令详情见 docs/cli/query.mdx。

本地viewer：可视化浏览你的知识Wiki

现在运行下面命令，浏览器会自动打开本地的只读 viewer：

llmwiki view --open

viewer 默认绑定127.0.0.1，只在你本机可访问，安全放心。界面包含：

• 📊Dashboard：概念数、来源数、待处理问题一目了然
• 🔍全文搜索：⌘K/Ctrl+K随时唤起
• 🕸️图谱浏览器（#/graph）：力导向图展示概念之间的互链关系
• 🏷️引用芯片：每个论断旁的引用可点开查看来源原文和行号
• 🎨四套主题：Scientific Clay（默认）、Minimal（跟随系统明暗）、Nebula Light / Dark

Minimal 主题则跟随操作系统的明暗设置自动切换，两种风格都清晰易读：

⚠️ 注意：viewer 是只读的，且展示的是启动时的快照。编译了新页面后，Ctrl+C停掉 viewer 重新运行llmwiki view --open即可看到更新。所有写操作都走 CLI。详细功能（健康页、审核队列、生命周期状态等）见 docs/cli/view.mdx。

新手常见问题 FAQ

Q：不想用 Anthropic，能完全离线吗？A：可以。通过LLMWIKI_PROVIDER=ollama接入本地 Ollama 模型，全程离线编译。

Q：编译会持续花我的 API 钱吗？A：增量编译机制会跳过未变化的来源（通过 SHA-256 哈希检测），只有新增或修改的来源才会重新走 LLM 流程。

Q：我该怎么知道下一步做什么？A：在项目目录运行llmwiki next，它会检查项目状态并推荐当下最有用的那条命令。

Q：如何检查 Wiki 质量？A：llmwiki lint检查断链、引用、元数据和新鲜度；llmwiki eval输出质量健康分。详见 docs/cli/lint-eval.mdx。

Q：之后要加新资料怎么办？A：llmwiki ingest <文件或URL>加入新来源，再llmwiki compile增量编译即可。

写在最后

回顾一下本教程的核心路径：npm 安装 → 配置 API key →quickstart一条命令 →query自然语言查询 →view本地可视化浏览。整个流程 5 分钟，你就能拥有第一个可查询、可溯源、可持续生长的个人知识 Wiki 📚

想更进一步？

• 搭建科研/编辑部类型化项目：llmwiki template init autosci或newsroom，模板文档见 docs/guides/
• 让 AI Agent 接入你的 Wiki：llmwiki serve启动 MCP 服务器，指南见 docs/guides/mcp-agent-integration.mdx
• 在 TypeScript 中编程驱动：createWiki({ root })SDK，见 docs/guides/sdk.mdx

原始资料进，互联 Wiki 出——这就是 llm-wiki-compiler 的全部魔法，现在轮到你了 🛠️

【免费下载链接】llm-wiki-compilerThe knowledge compiler. Raw sources in, interlinked wiki out. Inspired by Karpathy's LLM Wiki pattern.项目地址: https://gitcode.com/gh_mirrors/ll/llm-wiki-compiler