chatgpt-md  by bramses

Obsidian plugin for LLM integration

created 2 years ago
997 stars

Top 38.0% on sourcepulse

GitHubView on GitHub
Project Summary

This plugin integrates ChatGPT, OpenRouter.ai, and local LLMs via Ollama into Obsidian, enabling users to leverage AI directly within their notes for tasks like research, writing, and coding. It targets Obsidian users seeking enhanced productivity and AI-powered workflows, offering flexibility in AI model selection and deployment.

How It Works

The plugin facilitates direct interaction with various LLM providers through Obsidian's interface. Users can initiate chats from any Markdown note, providing context via linked notes or system commands. It supports per-note configuration through frontmatter, allowing customization of models, system prompts, and API endpoints for specific tasks. This approach offers a seamless, integrated AI experience within the familiar Obsidian environment.

Quick Start & Requirements

  • Install via Obsidian Community Plugins: Settings > Community Plugins > Browse > ChatGPT MD > Install.
  • Add API keys (OpenAI, OpenRouter.ai) or install Ollama for local LLMs.
  • Start chats using the ChatGPT MD: Chat command (hotkey recommended).
  • Official Docs: https://github.com/bramses/chatgpt-md

Highlighted Details

  • Supports Perplexity Source Citations via OpenRouter.ai without a Perplexity Pro subscription.
  • Offers per-note configuration via frontmatter for OpenAI, OpenRouter.ai, and Ollama.
  • Enables linking note context for richer AI interactions.
  • Provides privacy via local LLM execution with Ollama.

Maintenance & Community

  • Developed by Bram and Deniz.
  • Contributions are welcomed.
  • Developer Bram is building Your Commonbase.

Licensing & Compatibility

  • License: MIT.
  • Compatible with Obsidian's plugin ecosystem.

Limitations & Caveats

  • Mobile streaming requires Ollama without CORS issues.
  • Desktop-only functionality for stopping ongoing streams.
  • Previous url parameter in frontmatter is deprecated; service-specific URLs (openaiUrl, openrouterUrl, ollamaUrl) are now required.
Health Check
Last commit

3 weeks ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
6
Star History
83 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.