https://github.com/pfrankov/obsidian-local-gpt
Local Ollama and OpenAI-like GPT's assistance for maximum privacy and offline access
https://github.com/pfrankov/obsidian-local-gpt
Last synced: 4 days ago
JSON representation
Local Ollama and OpenAI-like GPT's assistance for maximum privacy and offline access
- Host: GitHub
- URL: https://github.com/pfrankov/obsidian-local-gpt
- Owner: pfrankov
- License: mit
- Created: 2023-12-03T10:53:06.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-05T19:59:04.000Z (about 1 month ago)
- Last Synced: 2025-04-12T01:06:38.567Z (4 days ago)
- Language: TypeScript
- Homepage:
- Size: 818 KB
- Stars: 477
- Watchers: 8
- Forks: 36
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-obsidian-ai-tools - https://github.com/pfrankov/obsidian-local-gpt
- awesome-obsidian-ai-tools - https://github.com/pfrankov/obsidian-local-gpt
- awesome-ChatGPT-repositories - obsidian-local-gpt - Local Ollama and OpenAI-like GPT's assistance for maximum privacy and offline access (Langchain)
- project-awesome - pfrankov/obsidian-local-gpt - Local Ollama and OpenAI-like GPT's assistance for maximum privacy and offline access (TypeScript)
README
# Local GPT plugin for Obsidian
_No speedup. MacBook Pro 13, M1, 16GB, Ollama, orca-mini._
The plugin allows you to open a context menu on selected text to pick an AI-assistant's action.
The most casual AI-assistant for Obsidian.
Also works with images
_No speedup. MacBook Pro 13, M1, 16GB, Ollama, bakllava._
Also it can use context from links, backlinks and even PDF files (RAG)
How to use (Ollama)
1. Install Embedding model:
- For English:
ollama pull nomic-embed-text(fastest) - For other languages:
ollama pull bge-m3(slower, but more accurate)
2. Select Embedding provider in plugin's settings and try to use the largest model with largest context window.
### Default actions
- Continue writing
- Summarize text
- Fix spelling and grammar
- Find action items in text
- General help (just use selected text as a prompt for any purpose)
- New System Prompt to create actions for your needs
You can also add yours, share the best actions or get one [from the community](https://github.com/pfrankov/obsidian-local-gpt/discussions/2).
## Installation
### 1. Install Plugin
#### Obsidian plugin store (recommended)
This plugin is available in the Obsidian community plugin store https://obsidian.md/plugins?id=local-gpt
#### BRAT
You can also install this plugin via [BRAT](https://obsidian.md/plugins?id=obsidian42-brat): `pfrankov/obsidian-local-gpt`
### 2. Install AI Providers Plugin
You also need to install AI Providers plugin to configure AI providers from plugin store https://obsidian.md/plugins?id=ai-providers
### 3. Configure AI Providers
Follow the instructions in [AI Providers](https://github.com/pfrankov/obsidian-ai-providers#create-ai-provider) plugin.
### Configure Obsidian hotkey
1. Open Obsidian Settings
2. Go to Hotkeys
3. Filter "Local" and you should see "Local GPT: Show context menu"
4. Click on `+` icon and press hotkey (e.g. `⌘ + M`)
## My other Obsidian plugins
- [Colored Tags](https://github.com/pfrankov/obsidian-colored-tags) that colorizes tags in distinguishable colors.
- [Obsidian AI Providers](https://github.com/pfrankov/obsidian-ai-providers) is a hub for AI providers.
## Inspired by
- [Obsidian Ollama](https://github.com/hinterdupfinger/obsidian-ollama).