lumina-wiki

v1.9.2

Published

6 days ago

Domain-agnostic, multi-IDE wiki scaffolder — Karpathy's LLM-Wiki vision, cross-platform and pack-based.

0High
0Medium
0Low

luutronghieu

llm-wiki knowledge-base wiki ai claude-code codex obsidian scaffolder karpathy

Lumina-Wiki

Where Knowledge Starts to Glow.
把 AI 变成您的个人知识助手和第二大脑。

1. 核心工作流

Lumina-Wiki 遵循一个简单原则：将您的原始资料与 AI 的结构化知识分开。

+-------------------------+      /lumi-ingest      +---------------------------+
|      您的输入            | ---------------------> |      AGENT 的大脑         |
|      (raw/ 文件夹)       |                        |      (wiki/ 文件夹)       |
|                         | <--------------------- |                           |
|  - paper.pdf            |       /lumi-ask        |  - paper.md (摘要)        |
|  - notes.txt            |                        |  - concept-a.md           |
+-------------------------+                        +---------------------------+

您提供： 将文档（PDF、笔记）放入 raw/ 目录。
Agent 构建： 在 AI 对话中使用指令（如 /lumi-ingest），让 Agent 从 raw/ 读取内容，并在 wiki/ 中构建结构化、互相关联的维基。
您使用： 通过 /lumi-ask 直接向 wiki/ 中的 Agent“大脑”提问，获得更快、更贴合上下文的回答。

2. 快速开始

第一步：安装

用一条命令把 wiki 工作区安装到当前项目中：

运行此命令前，您的电脑需要安装 Node.js。如果尚未安装，请从官方网站下载并安装推荐版本：nodejs.org/en/download。

npx lumina-wiki install

Windows 用户注意： 为了获得最佳体验，建议启用开发者模式，以便安装程序正确使用符号链接。如果开发者模式关闭，安装程序会退回到复制 skill 文件；功能仍然可用，但对后续更新不如符号链接理想。

安装程序会引导您完成几个快速设置步骤，包括选择可选的 Packs，例如 research（研究）、reading（阅读）和 learning（学习）。

第二步（可选）：配置 Research Pack

如果您安装了 research 包，部分技能可以使用 API key 来获得更好的在线搜索效果。在 AI 对话中运行：

您： /lumi-research-setup

Agent 会引导您检查研究工具，并在需要时把 key 保存到本地 .env 文件中。

第三步（升级时）：迁移旧版 Wiki 条目

如果您在已经有旧版 wiki/ 的项目上重新安装 Lumina-Wiki，直接再次运行 npx lumina-wiki install 即可。安装器会更新 scripts、schemas 和 skills；您在 wiki/、raw/、log.md 中的内容不会被修改。

您可以在项目根目录或其子目录中运行该命令。如果从设置中移除某个包或 AI 工具，Lumina 会清理旧命令和未经您修改的设置文件。您修改过的文件会保留，并显示警告。如果整个项目被复制、移动或重命名，Lumina 会在升级时修复由系统管理的链接。

如果安装器提示旧条目缺少新的 frontmatter 字段，可以用两种方式回填：

推荐： 打开 AI 对话并运行 /lumi-migrate-legacy。
更快： 运行终端命令：

node _lumina/scripts/wiki.mjs migrate --add-defaults

有关各版本 schema 变更的细节，请查看 CHANGELOG.md 或安装后的本地副本 _lumina/CHANGELOG.md。

3. 您的第一组指令（核心技能）

在 AI Agent 的聊天界面中使用这些指令与 wiki 交互，例如 Gemini CLI、Claude 等。

阶段一：导入与构建知识

/lumi-init: 扫描 raw/ 目录并执行首次 wiki 构建。
/lumi-ingest [path/to/file]: 把一份新文档加入知识库。AI 会先请你审阅草稿；如果没有需要你判断的问题，就会继续完成后续步骤。

阶段二：查询与维护

/lumi-ask [您的问题]: 基于 wiki/ 中的完整知识库提问。
/lumi-edit [path/to/wiki/page]: 要求修改或修正某个具体 wiki 页面。
/lumi-check: 检查整个 wiki 的问题（断链、孤立页面等）。

如果您安装了 research、reading 或 learning 等可选包，还会有额外技能可用。

4. 目录结构指南

Lumina 会创建一个工作区，每个目录都有明确用途。

通常您只需要在 raw/ 中工作，并阅读 wiki/ 中的结果；不需要修改系统目录。

使用 Obsidian 浏览 Wiki（可选）

Obsidian 是一款本地 Markdown 笔记应用，可以帮助您阅读和浏览互相关联的笔记。由于 Lumina-Wiki 也生成 Markdown 文件，您可以用 Obsidian 打开项目根目录，更方便地阅读 wiki。更多信息请见用户指南。

使用 qmd 进行本地搜索（高级，可选）

随着 Wiki 的增长，您可以使用 qmd 实现更快的本地 Markdown 搜索。如果您的 IDE 支持 Skill 格式，请安装官方 qmd skill：

npx skills add https://github.com/tobi/qmd --skill qmd

有关详细的安装和配置，请参阅高级指南。

5. 可用技能

这些是您在与 AI 对话时可以使用的指令。

后台脚本位于 _lumina/scripts/ 和 _lumina/tools/；通常您不需要直接调用它们。

6. 未来规划

Lumina-Wiki 正在快速演进。这是我们的用户路线图：

近期计划（稳定性与新导入支持）

[x] /lumi-help 技能： 智能助手读取工作区状态并告诉你下一步该做什么；加参数 /lumi-help skills 可查看全部命令清单，或 /lumi-help explain <主题> 询问 Lumina 本身的工作原理。（v1.4 已发布）
[x] 学习包（Learning Pack）： 自我反思功能，帮助您追踪对某个概念的理解随时间的演变。（v1.4 已发布）
[x] 多语言安装： 安装时可选英文、越南文或中文作为主语言。（v1.2 已发布）
[x] 原生 DOCX、RTF 与 EPUB 导入： 通过 research pack 将 Word、Rich Text 与 EPUB 电子书直接导入维基。（v1.x 已发布）
[x] 改进的 CI/CD： 正式支持 Bun 和 Node 22 环境。（v1.2 已发布）
[x] 全球数据源扩展： 直接集成 OpenAlex、CORE 和 Unpaywall，实现可靠的 DOI-to-PDF 解析。（在 v1.6 中发布）
[x] RSS 与博客监控： 通过 watchlist 中的 type: feed 项，自动从您喜爱的实验室博客和期刊中发现新论文。（在 v1.6 中发布）
[x] 高级论文排名： 通过 /lumi-research-rank 查看研究论文的影响力评分和质量信号。（在 v1.7 中发布）

长期计划（深度研究与集成）

[ ] 图片 OCR 与扫描 PDF： 将截图与扫描版 PDF 导入维基。
[ ] 论文版本追踪： 当已导入的论文出现新修订版或正式发表版本时发出通知。
[ ] Google Workspace： 直接将 Google Docs 和 Sheets 导入知识图谱。
[ ] 多媒体支持： 通过转录处理 YouTube 视频和音频录音。
[ ] 知识图谱审计： 自动检测矛盾和结构偏移。

计划中

[ ] 桌面端应用： 专用的图形界面环境，方便管理维基。
[ ] 专业科学包： 为生物医学和物理研究人员提供深度集成。

完整的技术细节请见 ROADMAP.md。想要贡献？欢迎在 GitHub 上加入我们！

7. 贡献与许可

CLI 契约

CI 脚本和集成应参考 docs/cli-contract.md 了解 v1.x 稳定标志列表和退出码映射。未在其中列出的任何内容均为内部，可能在不另行通知的情况下更改。

本地开发（贡献者）

如果您想为 lumina-wiki 安装器做贡献：

# 1. 克隆并安装依赖
git clone https://github.com/tronghieu/lumina-wiki.git
cd lumina-wiki
npm ci

# 2. 运行测试
npm run test:all

8. 其他语言

贡献者

感谢所有为 Lumina Wiki 做出贡献的人！

想要贡献？ 请阅读 CONTRIBUTING.md 开始参与——欢迎提交 Bug 报告、新 skill、工具集成以及翻译。