How jjwheatley/mini-rag works
Mini-RAG is an Obsidian plugin for chatting with a local Ollama model using selected vault notes as context. Users open a chat from the command palette or file menus; the plugin loads note or folder context, builds a searchable embedding index, retrieves relevant excerpts for questions, and displays streamed responses. It also supports context-free chats, model/settings management, summaries, and saving conversations. Relationships reflect the shown source references and README; some details of unsampled implementations are omitted.
Main entry points: main.ts Plugin lifecycle · chat-window.ts Chat view · contextualizer.ts Context assembly · ollama-wrapper.ts Ollama client
Components 20
Plugin entry
- Plugin lifecycle
main.ts - Context menus
src/classes/menu-manager.ts
Context retrieval
- Context assembly
src/classes/contextualizer.ts - Vector index
src/classes/vector-index.ts
Chat experience
- Chat view
src/classes/chat-window.ts - Conversation display
src/classes/ui/chat-conversation-window.ts - Chat input
src/classes/ui/chat-input.ts - Chat actions
src/classes/ui/chat-buttons.ts - Message history
src/classes/ui/chat-messages.ts - Loading indicator
src/classes/ui/chat-loading-animation.ts - Save-as modal
src/classes/ui/save-chat-as-modal.ts
Settings and models
- Ollama client
src/classes/ollama-wrapper.ts - Plugin settings
src/classes/settings-tab.ts - Default settings
src/defaults.ts
Vault persistence
- Vault file access
src/classes/file-manager.ts - Embedding cache
src/classes/contextualizer.ts - Saved chats
src/classes/file-manager.ts - Chat export formatting
src/utils.ts
Other components
- Obsidian user
- Local Ollama
Connections 28
- Obsidian user → Context menus: opens chat
README.md - Obsidian user → Plugin lifecycle: opens panel
README.md - Context menus → Plugin lifecycle: loads context
src/classes/menu-manager.ts - Plugin lifecycle → Chat view: registers view
main.ts - Plugin lifecycle → Plugin settings: registers settings
main.ts - Plugin lifecycle → Context menus: loads menus
main.ts - Plugin lifecycle → Ollama client: creates client
main.ts - Plugin lifecycle → Context assembly: creates contextualizer
main.ts - Context menus → Context assembly: adds file context
src/classes/menu-manager.ts - Context assembly → Vault file access: reads note text
src/classes/contextualizer.ts - Context assembly → Vector index: populates and queries
src/classes/contextualizer.ts - Context assembly → Ollama client: requests embeddings
src/classes/contextualizer.ts - Context assembly → Embedding cache: reads and writes
src/classes/contextualizer.ts - Chat view → Context assembly: gets relevant context
src/classes/chat-window.ts - Chat view → Ollama client: sends questions
- Ollama client → Local Ollama: requests model output
src/classes/ollama-wrapper.ts - Ollama client → Local Ollama: lists models
src/classes/ollama-wrapper.ts - Chat view → Conversation display: renders messages
src/classes/chat-window.ts - Chat view → Chat input: initializes input
src/classes/chat-window.ts - Chat view → Chat actions: initializes actions
src/classes/chat-window.ts - Chat view → Message history: records messages
src/classes/chat-window.ts - Chat view → Loading indicator: shows loading
src/classes/chat-window.ts - Chat actions → Plugin lifecycle: saves conversation
- Plugin lifecycle → Save-as modal: opens save dialog
main.ts - Save-as modal → Plugin lifecycle: writes named chat
src/classes/ui/save-chat-as-modal.ts - Plugin lifecycle → Chat export formatting: formats export
main.ts - Plugin lifecycle → Vault file access: updates vault file
main.ts - Plugin settings → Default settings: uses defaults
src/classes/settings-tab.ts