Getting Started

Install the plugin

Open Obsidian and go to Settings → Community plugins → Browse. Search for SANE and click Install, then Enable.

Alternatively, download the latest release from GitHub and copy main.js, manifest.json, and styles.css into .obsidian/plugins/sane/.

Configure an AI provider

Go to Settings → SANE. Under AI Provider, choose your preferred service. The default is OpenAI.

Enter your API key in the corresponding secret field. SANE stores keys in Obsidian's secure secret storage — they are never written to disk in plain text.

Set a target folder (recommended)

Under Security & Scope, set a Target Folder to limit which notes SANE processes. For example, Notes or Projects/Active.

Leaving this blank tells SANE to process every note in your vault. This is fine for small vaults, but limiting scope saves cost and keeps processing fast.

Initialize your existing notes

Open the Obsidian command palette (Cmd/Ctrl + P) and run SANE: Initialize all notes. This processes every note in your target folder, building the semantic index SANE uses to find related notes.

A status bar indicator will show progress. You can continue using Obsidian while SANE works in the background.

Write — SANE handles the rest

Create or edit any note in your target folder. Depending on your trigger mode, SANE will process it immediately, after a delay, or on a schedule.

When processing completes, the note's frontmatter will contain new sane_* fields. Your original prose is never touched.

---
title: "My Note"
sane_tags: ["topic-a", "topic-b"]
sane_keywords: ["key concept", "idea"]
sane_links: ["Related Note", "Another Note"]
sane_summary: "A short summary of this note."
---

See Output & Frontmatter for a full explanation of every field SANE adds.