README file from
GithubAI Chat for Obsidian
A powerful Obsidian plugin with multi-provider AI support: Yandex AI Studio, Groq (free), OpenAI, Anthropic Claude, GigaChat (Sber).
Features
- 💬 Chat panel — full chat in the sidebar with persistent history between sessions
- 🗄️ Vault search — AI finds relevant notes and answers based on them (RAG)
- 📅 Date-aware search — ask "what did I write on April 12th?" and AI uses note creation/modification dates
- 📄 Note context — add the current note to context with one click
- ✂️ Inline editing — select text → right-click → translate / shorten / improve / explain
- 🔄 Text replacement — after AI responds, it offers to replace the selected text in your note
- 📋 Sources — shows which notes AI used, with clickable links to open them
- 🔗 Clickable note references — note.md links in AI responses open directly in Obsidian
- 📱 Mobile support — adaptive layout for Obsidian Mobile
- 🎨 Dark/light theme — adapts automatically to your Obsidian theme
- 🌍 Bilingual UI — Russian and English interface based on your Obsidian language setting
Supported Providers
| Provider | Cost | Models |
|---|---|---|
| Groq | Free | Llama 3.3 70B, Mixtral 8x7B, Gemma 2 |
| Yandex AI | Paid | YandexGPT Pro/Lite/32k, Llama |
| OpenAI | Paid | GPT-4o, GPT-4o mini, GPT-3.5 |
| Anthropic | Paid | Claude Opus/Sonnet/Haiku |
| GigaChat | Paid | GigaChat, Plus, Pro, Max |
Installation
Via BRAT (recommended for beta testing)
- Install the BRAT plugin from the Obsidian community catalog
- BRAT → "Add Beta plugin" →
logotipza/obsidian-ya-gpt - Enable the plugin in Settings → Community plugins
Manual installation
git clone https://github.com/logotipza/obsidian-ya-gpt.git
cd obsidian-ya-gpt
npm install
npm run build
cp main.js manifest.json styles.css /path/to/vault/.obsidian/plugins/obsidian-ya-gpt/
API Key Setup
Groq — Free ⭐
- Go to console.groq.com
- Sign up (free, no credit card required)
- API Keys → Create API Key
- Paste the key in plugin settings
Yandex AI Studio
- Go to console.yandex.cloud
- Create a service account
- IAM → API Keys → Create
- Copy your Folder ID from the catalog URL
- Paste both values in plugin settings
OpenAI
- Go to platform.openai.com/api-keys
- Create new secret key
- Paste the key in plugin settings
Anthropic Claude
- Go to console.anthropic.com
- API Keys → Create Key
- Paste the key in plugin settings
GigaChat (Sber)
- Go to developers.sber.ru and sign in with Sber ID
- Create a project and connect the GigaChat API
- In the Authorization Data section, copy the Authorization Key
- Paste the key in plugin settings
Usage
Chat
- Click the 🤖 icon in the sidebar, or use
Cmd+P → Open Ya GPT Chat - Enter — send message, Shift+Enter — new line
Vault Search
- Click the 🗄️ button in the chat header (turns red when active)
- AI will find relevant notes and show them as clickable sources below its response
- Ask date-based questions: "What did I write about marketing in March?"
Inline Editing
- Select text in any note
- Right-click → Ya GPT section:
- Translate — auto-detects language direction
- Shorten — concise version preserving meaning
- Improve text — style and readability
- Explain — simple explanation
- Ask... — your custom question
- The response appears in the chat with a "Replace in note" button
Commands (Cmd+P)
| Command | Description |
|---|---|
| Open Ya GPT Chat | Open the chat panel |
| Summarize current note | Brief AI summary |
| Improve selected text | Style improvement |
| Translate selected | Auto-translate |
Security
- API keys are stored locally in Obsidian's encrypted storage (
data.json), never sent to third parties - Requests go directly from your device to the chosen AI provider
- Chat history is stored locally in your device's
localStorageonly - Vault data is sent only within your AI request context, and only when you explicitly enable Vault or Note Context mode
- The plugin collects no analytics and sends no data to external servers
- Source code is open and auditable: github.com/logotipza/obsidian-ya-gpt
Development
npm run dev # watch mode for development
npm run build # production build
License
MIT © logotipza