obsidian-local-gpt
obsidian-local-gpt copied to clipboard
Local GPT assistance for maximum privacy and offline access
Local GPT plugin for Obsidian
No speedup. MacBook Pro 13, M1, 16GB, Ollama, orca-mini.
Local GPT assistance for maximum privacy and offline access.
The plugin allows you to open a context menu on selected text to pick an AI-assistant's action.
Also works with images
No speedup. MacBook Pro 13, M1, 16GB, Ollama, bakllava.
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)
You can also add yours, share the best actions or get one from the community.
Supported AI Providers:
- Ollama
- OpenAI compatible server (also OpenAI)
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: pfrankov/obsidian-local-gpt
2. Install LLM
Ollama (recommended)
- Install Ollama.
- Install Qwen2 (default)
ollama pull qwen2or any preferred model from the library.
Additional: if you want to enable streaming completion with Ollama you should set environment variable OLLAMA_ORIGINS to *:
- For MacOS run
launchctl setenv OLLAMA_ORIGINS "*". - For Linux and Windows check the docs.
OpenAI compatible server
There are several options to run local OpenAI-like server:
- llama.cpp
- llama-cpp-python
- LocalAI
- Obabooga Text generation web UI
- LM Studio
- ...maybe more
Configure Obsidian hotkey (optional)
- Open Obsidian Settings
- Go to Hotkeys
- Filter "Local" and you should see "Local GPT: Show context menu"
- Click on
+icon and press hotkey (e.g.⌘ + M)
"Use fallback" option
It is also possible to specify a fallback to handle requests — this allows you to use larger models when you are online and smaller ones when offline.
Example video
Using with OpenAI
Since you can provide any OpenAI-like server, it is possible to use OpenAI servers themselves.
Despite the ease of configuration, I do not recommend this method, since the main purpose of the plugin is to work with private LLMs.
- Select
OpenAI compatible serverinSelected AI provider - Set
OpenAI compatible server URLtohttps://api.openai.com - Retrieve and paste your
API keyfrom the API keys page - Click "refresh" button and select the model that suits your needs (e.g.
gpt-3.5-turbo)
Example screenshot
My other Obsidian plugins
- Colored Tags that colorizes tags in distinguishable colors.