Grimoire documentation
These pages track the open-source app in 3ravens/Grimoire.
They are written for users and contributors based on the current source tree and README, not marketing copy alone.
What to read first
| Page | What it covers |
|---|---|
| Getting started | Download installers (v1.0+), first note, first LLM — no vault-folder picker |
| Installers & uninstall | Download, trust warnings, app data paths, uninstall preserves data by default |
| Troubleshooting | Ollama, RAG, Wikipedia, file scanner, app-data backup/move, performance |
| Note editor & Markdown | Read/edit, tags, wiki-links, transclusion, save→index, templates, export, Improve |
| Search | Ctrl+F, FTS + semantic, locked content, relationship to RAG |
| AI assistant | Local Ollama, chat API, context toggles, keep_alive, common errors |
| Vault & data | com.grimoire.app app data, SQLite, LanceDB, export, backups |
| Privacy & security | Local-first flow, vault vs folder passwords, lock, audit log |
| Views & surfaces | Editor, tabs, search, chat, graph, calendar, kanban, database, Wikipedia, scanner, settings, focus |
| Settings glossary | Every Settings section (LLM through Help, Developer in dev builds) |
| Keyboard shortcuts | Global shortcuts from keyboardService (incl. Shift+F10) |
| Development & tests | Native deps, npm run tauri dev, Rust/src-tauri + Vitest tests, Wikipedia benchmark |
For a short FAQ and install summary, see the marketing Help page.
For downloads and release status, see Download.