RecallLocus Obsidian Plugin

An Obsidian plugin that syncs your vault to a Locus semantic search instance. Query your notes in natural language or chat with an Ollama LLM to find relevant information across your vault.

Features

• Semantic search — query your notes in plain language and get ranked results with highlighted excerpts
• Auto-sync — notes are pushed to RecallLocus automatically when created, modified, renamed, or deleted
• Startup sync — optionally re-sync the full vault on every Obsidian launch
• Click-to-open — clicking a result opens the source note directly

Requirements

A running Locus instance. By default the plugin expects it at http://localhost:8000.

Installation

Community plugins (recommended)

1. Open Settings → Community plugins and disable Safe mode if prompted.
2. Click Browse and search for RecallLocus.
3. Install and enable the plugin.

Manual

1. Download main.js, manifest.json, and styles.css from the latest release.
2. Copy them into your vault's .obsidian/plugins/recall-locus/ directory.
3. Enable the plugin in Settings → Community plugins.

Configuration

Open Settings → RecallLocus and fill in:

Setting	Description	Default
RecallLocus URL	Base URL of your RecallLocus instance	http://localhost:8000
Space name	RecallLocus space this vault maps to (created automatically)	(required)
Auto-sync	Push note changes to RecallLocus in real time	on
Sync on startup	Full vault sync when Obsidian loads	on
Default result count	How many results to show (1–50)	5

Use the Test button next to the URL field to verify connectivity. Use Sync now to manually trigger a full vault sync, or Clear cache to force a full re-ingest on the next sync.

Usage

Open the search panel via:

• The search ribbon icon
• Command palette: RecallLocus: Open search panel
• Command palette: RecallLocus: Sync vault now

Type a query and press Enter or click Search. Results show the note title, a similarity score, and a highlighted text excerpt. Click any result to open the note.

Development

npm install
npm run dev       # watch mode
npm run build     # type-check + production bundle

The plugin is built with esbuild and targets the Obsidian plugin API. Source files live in src/:

• main.ts — plugin entry point, vault event wiring, status bar
• recall-locus-client.ts — HTTP client for the RecallLocus REST API
• sync-engine.ts — tracks synced files (path → doc ID + mtime) and drives ingest/delete/rename
• chat-panel.ts — sidebar ItemView with the search UI
• settings.ts — settings schema, defaults, and settings tab UI

Sync state (SyncData) is persisted alongside settings via Obsidian's loadData/saveData. The engine compares each file's mtime against the stored record to skip unchanged notes during a full sync.