llm-wiki-compiler 5分钟快速上手:安装llmwiki并从一份Markdown构建可查询知识库
【免费下载链接】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)是一款开源知识编译器:原始资料进来,互链、可溯源、可查询的知识 Wiki 出来。它实现了 Karpathy 提出的 LLM Wiki 模式——把散落的 Markdown、网页、PDF 一次性"编译"成带引用标注的持久化知识页面,之后你可以用自然语言提问、在浏览器中浏览、导出给 AI 智能体复用。本文面向新手,带你 5 分钟完成安装,并从一份 Markdown 文件构建出第一个可查询知识库。
1️⃣ 一键安装 llmwiki:最快安装步骤
安装前只需确认环境要求:
- Node.js ≥ 24(硬性要求,用
node --version检查,版本不足可用nvm或fnm升级) - npm(随 Node.js 自带)
全局安装一条命令搞定:
npm install -g llm-wiki-compiler验证是否安装成功:
llmwiki --version能打印版本号就说明llmwiki命令已就绪。完整的安装与 Provider 配置说明见 docs/installation.mdx。
2️⃣ 配置 API Key:5 秒完成 Provider 设置
llmwiki在"编译"和"查询"阶段会调用大模型,默认使用 Anthropic,只需导出一个环境变量:
export ANTHROPIC_API_KEY=sk-ant-...📌 小贴士:把配置写在项目根目录的.env文件中,llmwiki 每次执行命令都会自动加载,不用反复 export。
没有 Anthropic Key 也没关系,llmwiki 支持多种 Provider,按需切换即可:
| Provider | 关键环境变量 |
|---|---|
| OpenAI 兼容服务 | LLMWIKI_PROVIDER=openai+OPENAI_API_KEY |
| Ollama(本地模型) | LLMWIKI_PROVIDER=ollama+OLLAMA_HOST |
| GitHub Copilot | LLMWIKI_PROVIDER=copilot+GITHUB_TOKEN |
完整选项参考 docs/configuration/providers.mdx。另外注意:ingest(导入)、view(浏览)、lint等只读操作不需要任何 API Key。
3️⃣ 核心玩法:一条 quickstart 命令从 Markdown 构建知识库
准备工作全部完成。新建一个项目目录,把你手头任意一份 Markdown 文件放进去,然后执行:
mkdir my-wiki && cd my-wiki llmwiki quickstart ./notes.md就是这一条命令!quickstart会自动完成三步:导入来源 → 两阶段 LLM 编译 → 打开本地浏览器查看器。
编译完成后,项目目录会形成清晰的结构:
sources/ # 你的原始 Markdown 文件 wiki/ concepts/ # LLM 提取出的概念页面(带 [[wikilinks]] 互链) queries/ # 保存下来的问答页面 index.md # 自动生成的目录 .llmwiki/ # 编译器状态:哈希、所有权、配置📌 想先看效果?仓库自带一份无需 API Key 的示例成品:一份 Markdown 源文档被编译成了 7 个互链概念页,直接浏览 examples/basic/ 目录即可。
4️⃣ 让知识库真正"可查询":llmwiki query
构建完知识库,直接用自然语言提问:
llmwiki query "这份文档的核心观点是什么?"llmwiki 会用语义检索 + BM25 重排序 + 链接图扩展,从编译好的页面中组装出带引用的有据回答,而不是让模型凭空发挥。
加上--save参数,答案会作为新页面写回知识库,成为未来提问的上下文——知识就这样滚雪球式地积累起来:
llmwiki query "编译流程和增量更新有什么关系?" --save5️⃣ 浏览器可视化浏览:llmwiki view
llmwiki view --open查看器运行在127.0.0.1本地回环地址,只读、安全,不改写任何文件。左侧导航可按 Concepts / Queries / Sources 分类浏览,支持全文搜索、概念关系图和每段的引用徽章(citation chips),来源文件旁直接挂着出处:
1.3 版本起提供 4 套主题,右上角可一键切换。比如跟随系统深浅色的 Minimal 主题,清爽素净:
6️⃣ 常用命令速查表
上手后最常用的几个命令,收藏备用:
| 命令 | 作用 |
|---|---|
llmwiki ingest <url或文件> | 导入新的网页或本地文件到sources/ |
llmwiki compile | 增量编译:只重跑变化的来源 |
llmwiki query "问题" [--save] | 查询知识库,可选保存答案 |
llmwiki view --open | 打开本地浏览器查看器 |
llmwiki lint | 校验链接、引用、新鲜度 |
llmwiki status | 查看页面/来源数量与项目健康度 |
llmwiki next | 不确定下一步做什么时,它会推荐最合适的命令 |
全部命令的详细说明见 docs/cli/ 目录。
7️⃣ 新手常见问题(FAQ)
❓ 提示 Node 版本不兼容?llmwiki 要求 Node.js ≥ 24,用版本管理器(nvm/fnm)升级后即可运行。
❓ 没有 API Key 能玩吗?可以。ingest、view、lint、status等只读命令均不需要 Key;也可以直接浏览 examples/basic/ 中的预生成示例了解产出形态。
❓ 编译太慢怎么办?大来源可用--concurrency <n>提高 LLM 调用并发(默认 5),增量编译也会自动跳过未变化的来源。
❓ 生成的页面能进 Obsidian 吗?可以。编译产物是标准 Markdown,概念之间用[[wikilinks]]互链,直接拖进 Obsidian 就是可导航的知识图谱。
写在最后
从npm install到查询自己的知识库,llm-wiki-compiler 只需要三条命令。它的核心理念很纯粹:把"查询时反复检索原始文件"的工作前移到"编译时",让知识沉淀为可积累、可审计、可复用的页面。
下一步建议:把llmwiki quickstart指向一篇你常查的长文,再运行llmwiki next让工具告诉你该做什么——关于 LLM Wiki 模式的更多原理,可阅读 docs/concepts/karpathy-pattern.mdx,快速上手完整文档见 docs/quickstart.mdx。
【免费下载链接】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
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考