{"id":29674298,"url":"https://github.com/rosmur/obsidian-summairize","last_synced_at":"2025-07-22T23:01:50.737Z","repository":{"id":297526900,"uuid":"994455411","full_name":"rosmur/obsidian-summairize","owner":"rosmur","description":"Obsidian plugin that generates local AI-powered summaries of your notes","archived":false,"fork":false,"pushed_at":"2025-07-12T00:32:39.000Z","size":39,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-19T12:10:21.407Z","etag":null,"topics":["obsidian","obsidian-md","obsidian-plugin","summarization","summarizer","summarizer-ai"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rosmur.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-02T00:41:54.000Z","updated_at":"2025-07-17T06:18:00.000Z","dependencies_parsed_at":"2025-06-06T00:26:59.556Z","dependency_job_id":"0f5842e7-c470-4556-9fe5-77f150b1069e","html_url":"https://github.com/rosmur/obsidian-summairize","commit_stats":null,"previous_names":["rosmur/obsidian-summaraize","rosmur/obsidian-summairize"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/rosmur/obsidian-summairize","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosmur%2Fobsidian-summairize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosmur%2Fobsidian-summairize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosmur%2Fobsidian-summairize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosmur%2Fobsidian-summairize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rosmur","download_url":"https://codeload.github.com/rosmur/obsidian-summairize/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rosmur%2Fobsidian-summairize/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266586839,"owners_count":23952195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["obsidian","obsidian-md","obsidian-plugin","summarization","summarizer","summarizer-ai"],"created_at":"2025-07-22T23:00:47.707Z","updated_at":"2025-07-22T23:01:50.726Z","avatar_url":"https://github.com/rosmur.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Summairize - AI-Powered Note Summarization for Obsidian\n\nObsidian plugin that generates local AI-powered summaries of your notes\n\n## Demo\n\n*One click and voila!*\n\nhttps://github.com/user-attachments/assets/facb4260-be10-45fe-a715-0bc1b1463422\n\n## Features\n\n- **Configurable**: Customize summary length, AI models, and exclusion rules\n- **Simple and Seamless**: Summaries are added directly to the top of your note\n- **Multiple AI Providers**: Currently supports Ollama; with llama.cpp, LMStudio etc. coming soon.\n\n## Prerequisites\n\nLocal inference through ollama is the first supported method and recommended - this assures your private notes don't leave your machine.\n\n### Ollama\n\n1. Install Ollama from [https://ollama.ai](https://ollama.ai)\n2. Pull the default model: `ollama pull gemma3:4b`\n3. Ensure Ollama is running: `ollama serve`\n\nNOTE: Gemma3:4b is a leading option for quality/size at the time of this writing. You can however use any model.\n## Installation\n\n### Manual\n\n1. Download the `main.js`, `manifest.json` and `styles.css` from the latest version on the GitHub releases page\n2. Extract the files to your Obsidian plugins folder: `\u003cvault\u003e/.obsidian/plugins/obsidian-summairize/`\n3. Enable the plugin in Obsidian Settings → Community Plugins\n\n### Development\n\n1. Clone this repository into your plugins folder:\n   ```bash\n   cd \u003cvault\u003e/.obsidian/plugins/\n   git clone https://github.com/yourusername/obsidian-summairize.git\n   cd obsidian-summairize\n   ```\n\n2. Install dependencies and build:\n   ```bash\n   npm install\n   npm run build\n   ```\n\n3. Enable the plugin in Obsidian Settings → Community Plugins\n\n## Usage\n\n### Generating Summaries\n\n1. **Ribbon Button**: Click the brain icon in the left ribbon\n2. **Command Palette**: Use `Ctrl/Cmd + P` and search for \"Generate Summary\"\n\nOptionally, assign a custom hotkey in Settings → Hotkeys\n\n### Summary Format\n\nSummaries are added to the top of your notes with the following format:\n\n```markdown\n# Summary\n\n## Generated by AI\n\n*Generated on [timestamp]*\n\n[Your AI-generated summary here]\n```\n\n### File Exclusions\n\nBy default, the plugin excludes:\n- Template files (files in \"Templates\" folders or containing \"template\" in the name)\n- Daily notes (files matching date patterns like \"2024-01-15.md\")\n\n## Configuration\n\nAccess plugin settings via Settings → Summairize:\n\n### AI Settings\n- **Ollama Model**: Specify which Ollama model to use (default: `gemma3:4b`)\n- **Summary Length**: Target word count for summaries (100-1000 words)\n\n### File Filtering\n- **Exclude Templates**: Skip template files\n- **Template Folders**: Specify folder names to exclude\n- **Exclude Daily Notes**: Skip daily note files\n- **Daily Notes Pattern**: Regex pattern for daily note filenames\n\n## Troubleshooting\n\nPlease try steps detailed [here](docs/TROUBLESHOOTING.md) and file an issue if your problem is still unresolved. \n### Common Issues\n\n- [Ollama is not installed](docs/TROUBLESHOOTING.md#step-1-verify-ollama-installation)\n- [Ollama service is not running](docs/TROUBLESHOOTING.md#step-2-check-ollama-service)\n- [Model not found](docs/TROUBLESHOOTING.md#step-3-check-model-availability)\n\n## Roadmap\n\n- [ ] Additional Model Server integration: llama.cpp, LMStudio etc.\n- [ ] Remote Model provider integration (if there's demand)\n- [ ] Custom prompt templates\n- [ ] Batch summarization by folder/rule\n- [ ] Auto summarization by folder/rule\n- [ ] Summary templates\n- [ ] Inline summary model metadata/info\n\n## Contributing\n\nSee development details and how to contribute [here](docs/CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frosmur%2Fobsidian-summairize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frosmur%2Fobsidian-summairize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frosmur%2Fobsidian-summairize/lists"}