llmwiki-suite

把一堆 Markdown 笔记编成「会生长、能问答」的个人知识库。

源自 Karpathy 的 LLM-wiki 思路：不做每次查询临时切片的 RAG，而是用工具链 持续编译笔记——补 frontmatter、建 BM25 + wikilink 图索引、巡检断链， 最后通过 CLI 或微信通道问答。

包名 vs 命令名：PyPI 发布名为 llmwiki-suite（llmwiki 这个包名已被其他项目占用）， 安装后执行命令仍然是 llmwiki —— 即「装的是 llmwiki-suite，用的是 llmwiki」。

安装

发布状态：尚未上 PyPI，以下 pip install 均从 GitHub 直装（main 分支最新）。 从 GitHub 直装时，[wechat] extra 不会自动带上 fastapi/uvicorn，跑渠道必须显式写 [wechat]。

# 二选一，不必两条都装：
#   只用 ingest / index / query / lint / eval（核心，零依赖）→ 装第 1 条即可
#   要跑微信/企业微信渠道（核心 + fastapi/uvicorn）→ 装第 2 条，它已包含核心

# ① 核心（零依赖，纯标准库）
pip install "llmwiki-suite @ git+https://github.com/voidvec/llmwiki-suite.git"

# ② 微信/企业微信通道（在核心之上额外装 fastapi + uvicorn；已含核心，无需再装①）
pip install "llmwiki-suite[wechat] @ git+https://github.com/voidvec/llmwiki-suite.git"

要求 Python >= 3.11。

本地开发安装（源码）

git clone https://github.com/voidvec/llmwiki-suite.git
cd llmwiki-suite
pip install -e .                 # 或带微信通道：pip install -e ".[wechat]"

五步接入你已有的笔记库

cd ~/my-notes          # 1. 进入你的笔记目录
llmwiki init           # 2. 生成 llmwiki.toml 配置模板
llmwiki ingest         # 3. 补 frontmatter + 规范化 wikilink
llmwiki index          # 4. 建检索索引
llmwiki query "..."    # 5. 检索 / 问答

可选：llmwiki lint（巡检断链/词表）、llmwiki eval（评估召回质量）、 llmwiki serve（启动 HTTP 问答服务，需 wechat extras）。

命令一览

所有命令支持 --repo <path> 显式指定库路径（默认取当前目录）。

微信渠道接入（个人微信 / 企业微信）

用 llmwiki serve 把知识库接到微信，直接发消息问答：

# ① 前提：必须装带 wechat extra 的包（核心安装不含 fastapi/uvicorn）
pip install "llmwiki-suite[wechat] @ git+https://github.com/voidvec/llmwiki-suite.git"

# ② 配置 LLM（OpenAI 兼容端点；只设 KEY 时默认走 OpenAI）
export LLM_WIKI_API_KEY="sk-xxx"
export LLM_WIKI_BASE_URL="https://api.openai.com/v1"        # 不设则默认 OpenAI
export LLM_WIKI_MODEL="gpt-4o-mini"                          # 不设则默认 gpt-4o-mini

export LLM_WIKI_BRIDGE_TOKEN="my-secret"       # 建议：保护 /chat、/recall
llmwiki serve --host 127.0.0.1 --port 8000

• 个人微信（推荐，免费官方 iLink 通道）：浏览器打开 http://127.0.0.1:8000/ilink/webui → 手机微信扫码 → 绑定成功后 直接在微信里给 bot 发消息即查即答。
• 企业微信：配置 LLM_WIKI_WECOM_* 环境变量后自动启用回调 / 主动推送通道。

换 LLM 厂商 / 模型（OpenAI 兼容协议即可）

套件只调 OpenAI 兼容的 /chat/completions，不看厂商名——任何提供该协议的服务都能用：

换厂商只需把上面三个变量一起设；只有 OpenAI 时只用 LLM_WIKI_API_KEY 即可。 支持任意 OpenAI /chat/completions 兼容的第三方服务（DeepSeek / 通义 / Kimi / 本地 Ollama / vLLM 等）， 完整对接步骤、会话持久化与排错，详见 [[llmwiki-tutorial-02-channel]]。

配置与密钥

• 库配置：库根 llmwiki.toml（categories 词表、排除目录、模型名等非密钥项）
• 密钥：只走环境变量（LLM_WIKI_API_KEY、LLM_WIKI_BRIDGE_TOKEN、 LLM_WIKI_WECOM_*、LLM_WIKI_ILINK_*），本套件不读取任何 .env 文件

文档

全部文档在 docs/，按「入口 → 进阶 → 参考」组织：

建议顺序：getting-started → tutorial-01 → 02/03（按需）→ architecture。

License

MIT