Lumina-Wiki
Where Knowledge Starts to Glow.
Turn the documents you read into a knowledge library you can ask questions about later.
Lumina-Wiki gives your AI assistant a lasting workspace for study and research. You add papers, books, reports, class notes, or personal notes. The assistant summarizes them, connects related ideas, and keeps the results in plain Markdown files on your computer.
What you can do
Lumina-Wiki is useful when you want to:
- keep what you learn from many documents in one place;
- compare ideas or evidence across several sources;
- prepare for an exam, essay, literature review, or long-term research project;
- return to an old topic without searching through previous chats;
- keep important answers together with the sources that support them.
You do not need to build the wiki by hand. You choose the sources and make the important decisions. Your AI assistant does the routine work of reading, organizing, linking, and checking notes.
How it works
Lumina-Wiki uses two main folders:
raw/ holds your original documents.wiki/ holds the organized notes created from those documents.
Your documents in raw/
|
| lumi-ingest
v
Organized notes in wiki/
|
| lumi-ask
v
Answers based on what you have read
Your original files stay separate from AI-written notes. This makes it easier to check where an idea came from and to correct the wiki when needed.
Start in a few minutes
Before you start
Install the current LTS version of Node.js. You also need an AI tool that can work with a folder on your computer, such as Codex, Claude Code, or Gemini CLI.
1. Create your workspace
Open a terminal in the folder where you want to keep your knowledge library, then run:
npx lumina-wiki install
The setup asks which AI tool and optional feature sets you want to use. If you are unsure, keep the suggested choices. You can run the same command again later to change them.
2. Add one document
Place a PDF, Markdown file, or text file in:
raw/sources/
For example:
raw/sources/my-first-paper.pdf
3. Ask your AI assistant to read it
In Codex, use:
$lumi-ingest raw/sources/my-first-paper.pdf
In tools that use slash commands, such as Claude Code or Gemini CLI, use:
/lumi-ingest raw/sources/my-first-paper.pdf
The assistant shows you a draft before saving the new notes. You can approve it, ask for changes, or stop and continue later.
4. Ask your first question
After the document has been added, try:
/lumi-ask What are the main ideas in this document?
Codex users can replace the first / with $.
If you are not sure what to do next, use /lumi-help or $lumi-help.
For a guided walkthrough with checkpoints and common fixes, see the user guide.
Optional feature sets
The basic features are always included. During setup, you can add:
| Feature set | Choose it when you want to |
|---|
| Research | Find papers, follow research topics, rank sources, and build literature reviews. |
| Reading | Read books chapter by chapter without revealing later plot details. |
| Learning | Record how your understanding changes as you study. |
You can add or remove an optional feature set later by running npx lumina-wiki install again. Your documents and wiki notes are preserved.
Everyday commands
These are enough for most people:
| Command | Use it to |
|---|
/lumi-help | Get one useful suggestion for what to do next. |
/lumi-ingest | Add a document to the wiki. |
/lumi-ask | Ask a question using the knowledge already in the wiki. |
/lumi-view | See the wiki in your browser: a map of the pages, a page list, and a reader. |
/lumi-edit | Correct or update a wiki page. |
/lumi-verify | Check that notes match the sources they cite. |
/lumi-check | Check the wiki for broken links and other problems. |
See the command reference for every classic-mode command. Project mode has its own skills — see Project mode below.
Guides
To browse the wiki, use /lumi-view. It starts a built-in viewer and gives you an address to open in your browser, with a map of how the pages relate. You can also open the project root in Obsidian to browse the Markdown notes.
Project mode
Project mode is a separate install for a software (or similar) project's own repo. It builds a typed graph over the docs already there (decisions, requirements, rules), instead of a new wiki. There is no raw/ or wiki/.
npx lumina-wiki install --mode project
See the project mode guide for what it installs and how to use it.
Update or uninstall
To update Lumina-Wiki or change your setup, run:
npx lumina-wiki install
To remove Lumina-Wiki's managed files, run:
npx lumina-wiki uninstall
Uninstalling keeps your original documents in raw/ and your knowledge notes in wiki/.
For contributors
Development instructions live in CONTRIBUTING.md. The stable command-line contract is documented in docs/cli-contract.md, and planned work is listed in ROADMAP.md.
Lumina-Wiki is available under the MIT License.
Contributors
Thanks to everyone who has contributed to Lumina Wiki!
Want to contribute? Read CONTRIBUTING.md to get started — bug reports, new skills, tool integrations, and translations are all welcome.
