项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1756
使用教程
环境要求
- Python 3.11+
- Node.js 20+
- 可选:安装 LibreOffice 以解析 Word/PowerPoint 文件
- 可选:设置 MISTRAL_API_KEY 以获得更高质量的 PDF OCR
- 一个存放你文档的本地文件夹(无需放在仓库内)
安装与启动步骤
-
1克隆仓库
把 llmwiki 源码克隆到本地并进入项目目录,后续命令都在此目录执行。
git clone https://github.com/lucasastorian/llmwiki.git cd llmwiki -
2建虚拟环境装依赖
创建 Python 虚拟环境并安装 api 与 mcp 两个依赖文件;Windows 请改用 PowerShell 版命令。
python -m venv .venv && source .venv/bin/activate pip install -r api/requirements.txt -r mcp/requirements.txt -
3安装前端依赖
进入 web 目录安装 Node 依赖后返回根目录,需已安装 Node.js 20+。
cd web && npm install && cd .. -
4打开你的文档目录
指向存放 PDF、Word、Markdown 等的文件夹,会自动建立索引、启动 API 与网页并打开浏览器。
./llmwiki open ~/research -
5生成 MCP 配置
打印 MCP JSON,粘贴到 Claude 客户端配置文件并保存,一个工作区对应一个 MCP 条目。
./llmwiki mcp-config ~/research -
6配置自动维护
把 README 中的 Routine 提示词设为每晚定时任务,让 Claude 自动读取新增内容并更新 Wiki。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
MISTRAL_API_KEY | 否 | 可选,用于获得更高质量的 PDF OCR 解析效果 | sk-xxxxxxxxxxxxxxxx |
NEXT_PUBLIC_ONBOARDING_PREVIEW | 否 | 开发用开关,仅预览引导页且不写入数据,改后需重启开发服务器 | true |
如何确认成功
命令执行后浏览器自动打开 localhost:3000 并能看到应用界面,即启动成功;API 仅监听 127.0.0.1。
常见问题
Q:Word、PowerPoint 文件无法解析怎么办?
A:README 说明需安装 LibreOffice 才能提取 Word/PowerPoint 内容,仅靠默认依赖无法解析这些格式。
Q:Windows 上激活虚拟环境报执行策略错误?
A:可执行一次 Set-ExecutionPolicy -Scope CurrentUser RemoteSigned,或跳过激活,直接用 .venv\Scripts\python 代替 python 执行命令。
Q:MCP 配置 JSON 应该粘贴到哪里?
A:Claude Desktop 粘贴到 claude_desktop_config.json,Claude Code 粘贴到 .claude/settings.json;一个工作区对应一个 MCP server 条目。
Q:能否让局域网其他机器访问?
A:不支持,本地模式刻意只做环回访问,API 绑定在 127.0.0.1,不提供 LAN 或远程绑定。
注意事项
- 本地模式仅监听 127.0.0.1,不要指望从其他设备访问。
- 程序不会移动、修改或上传你的原始文件,只会在工作区新增 wiki/ 目录和隐藏的 .llmwiki/ 索引。
- Windows 下把 ./llmwiki 换成 python llmwiki,路径写成 C:\Users\you\research 这类形式。
- 预览引导页的开关修改后必须重启开发服务器,且预览只在内存中模拟,不会真正创建 Wiki。
核心亮点
- 直接实现 Karpathy 的 LLM Wiki 理念,概念新颖且具有前瞻性
- 通过 MCP 原生集成 Claude,实现 AI 驱动的文档到 Wiki 的自动化流程
- 结合 RAG 与 Supabase,提供可检索、可扩展的后端存储方案
不足之处
- 依赖外部 Claude 账号和 MCP 服务,部署与使用门槛较高
- 文档/社区待观察:项目较新,文档完整性和社区支持尚需时间验证
适用场景
- 个人知识库自动化整理:将零散文档交给 AI 生成结构化 Wiki
- 团队协作知识管理:自动从项目文档、会议记录中提炼 Wiki 页面
- AI Agent 应用开发:作为 MCP 与 RAG 结合的学习参考
替代项目
Danswer、Khoj、Quivr
上一篇:paxm
下一篇:ACCESSIBILITY.md
同类项目推荐
nono
开源
秒级启动 AI 智能体沙箱,零配置隔离运行,安全又高效
agent runtime security - zero trust, zero setup, zero latency agent sandboxing
agent-town
开源
把多个 AI 智能体放进像素小镇里协作,过程看得见
A pixel-art AI agent online collaboration platform.
total-recall
开源
让 Claude Code 记住每次对话,告别重复解释
Persistent memory plugin for Claude Code. Tiered memory system with write gates, cor···
agent-orchestrator
开源
像管团队一样管编码智能体,从规划到合并全程可控
Plan, run and supervise fleets of agents from task to merged PR. Desktop (macOS, Win···
metaharness
开源
一键生成带品牌、记忆和签名的专属AI智能体框架
️ The meta-harness for AI agents — scaffold your own focused, branded agent harnes···
xiaozhi-mcp-ha
开源
让小智语音设备直接控制你的 Home Assistant 家居
A Home Assistant Custom Integration (HACS) that connects Xiaozhi ESP32 AI chatbot to···
Dida-RollingGo-Hotel-MCP-Global
开源
让 AI 直接订酒店,200万+房源批发价实时查
Official DIDA Hotel Booking MCP Server. 14-year travel tech data stack, 2M+ hotels a···
Multi-Agent-Study-Assistant
开源
6个AI智能体陪你学,自适应路径+即时问答,学习更高效
AI-powered learning platform with 6 specialized agents for personalized education. F···
ifai
开源
拖拽编排 AI Agent,像搭积木一样自动化复杂任务
若爱 (IfAI) — AI Agent 编排助手 & 代码编辑器 | An AI Agent Orchestrator & Code Edit···
