https://github.com/rosmur/obsidian-summairize
Obsidian plugin that generates local AI-powered summaries of your notes
https://github.com/rosmur/obsidian-summairize
obsidian obsidian-md obsidian-plugin summarization summarizer summarizer-ai
Last synced: 12 months ago
JSON representation
Obsidian plugin that generates local AI-powered summaries of your notes
- Host: GitHub
- URL: https://github.com/rosmur/obsidian-summairize
- Owner: rosmur
- License: mit
- Created: 2025-06-02T00:41:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-12T00:32:39.000Z (12 months ago)
- Last Synced: 2025-07-19T12:10:21.407Z (12 months ago)
- Topics: obsidian, obsidian-md, obsidian-plugin, summarization, summarizer, summarizer-ai
- Language: TypeScript
- Homepage:
- Size: 38.1 KB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Summairize - AI-Powered Note Summarization for Obsidian
Obsidian plugin that generates local AI-powered summaries of your notes
## Demo
*One click and voila!*
https://github.com/user-attachments/assets/facb4260-be10-45fe-a715-0bc1b1463422
## 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](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: `/.obsidian/plugins/obsidian-summairize/`
3. Enable the plugin in Obsidian Settings → Community Plugins
### Development
1. Clone this repository into your plugins folder:
```bash
cd /.obsidian/plugins/
git clone https://github.com/yourusername/obsidian-summairize.git
cd obsidian-summairize
```
2. Install dependencies and build:
```bash
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:
```markdown
# 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](docs/TROUBLESHOOTING.md) and file an issue if your problem is still unresolved.
### Common Issues
- [Ollama is not installed](docs/TROUBLESHOOTING.md#step-1-verify-ollama-installation)
- [Ollama service is not running](docs/TROUBLESHOOTING.md#step-2-check-ollama-service)
- [Model not found](docs/TROUBLESHOOTING.md#step-3-check-model-availability)
## 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](docs/CONTRIBUTING.md)