Summairize - AI-Powered Note Summarization for Obsidian

Obsidian plugin that generates local AI-powered summaries of your notes

Demo

One click and voila!

summairize.mov

Features

• Configurable: Customize summary length, AI models, and exclusion rules
• Simple and Seamless: Summaries are added directly to the top of your note
• Multiple AI Providers: Currently supports Ollama; with llama.cpp, LMStudio etc. coming soon.

Prerequisites

Local inference through ollama is the first supported method and recommended - this assures your private notes don't leave your machine.

Ollama

1. Install Ollama from https://ollama.ai
2. Pull the default model: ollama pull gemma3:4b
3. Ensure Ollama is running: ollama serve

NOTE: Gemma3:4b is a leading option for quality/size at the time of this writing. You can however use any model.

Installation

Manual

1. Download the main.js, manifest.json and styles.css from the latest version on the GitHub releases page
2. Extract the files to your Obsidian plugins folder: <vault>/.obsidian/plugins/obsidian-summairize/
3. Enable the plugin in Obsidian Settings → Community Plugins

Development

1. Clone this repository into your plugins folder:

   cd <vault>/.obsidian/plugins/
   git clone https://github.com/yourusername/obsidian-summairize.git
   cd obsidian-summairize

2. Install dependencies and build:

   npm install
   npm run build

3. Enable the plugin in Obsidian Settings → Community Plugins

Usage

Generating Summaries

1. Ribbon Button: Click the brain icon in the left ribbon
2. Command Palette: Use Ctrl/Cmd + P and search for "Generate Summary"

Optionally, assign a custom hotkey in Settings → Hotkeys

Summary Format

Summaries are added to the top of your notes with the following format:

# Summary

## Generated by AI

*Generated on [timestamp]*

[Your AI-generated summary here]

File Exclusions

By default, the plugin excludes:

• Template files (files in "Templates" folders or containing "template" in the name)
• Daily notes (files matching date patterns like "2024-01-15.md")

Configuration

Access plugin settings via Settings → Summairize:

AI Settings

• Ollama Model: Specify which Ollama model to use (default: gemma3:4b)
• Summary Length: Target word count for summaries (100-1000 words)

File Filtering

• Exclude Templates: Skip template files
• Template Folders: Specify folder names to exclude
• Exclude Daily Notes: Skip daily note files
• Daily Notes Pattern: Regex pattern for daily note filenames

Troubleshooting

Please try steps detailed here and file an issue if your problem is still unresolved.

Common Issues

• Ollama is not installed
• Ollama service is not running
• Model not found

Roadmap

• Additional Model Server integration: llama.cpp, LMStudio etc.
• Remote Model provider integration (if there's demand)
• Custom prompt templates
• Batch summarization by folder/rule
• Auto summarization by folder/rule
• Summary templates
• Inline summary model metadata/info

Contributing

See development details and how to contribute here