obsidian-companion  by rizerphe

Obsidian plugin for AI-powered autocompletion

created 2 years ago
327 stars

Top 84.6% on sourcepulse

GitHubView on GitHub
Project Summary

This plugin enhances Obsidian note-taking with AI-powered autocomplete, targeting knowledge workers, students, and researchers. It offers a "copilot-like" interface for faster writing by suggesting words, phrases, and sentences, improving productivity and creativity.

How It Works

Companion integrates with various AI models, including OpenAI's GPT-3/3.5 (ChatGPT) and locally hosted Ollama models, via a custom codemirror-companion-extension. Suggestions appear as ghost text, accepted with the Tab key, mimicking GitHub Copilot's workflow. This approach aims for unobtrusive, context-aware assistance.

Quick Start & Requirements

  • Install via Obsidian Community Plugins.
  • Requires an OpenAI API key for ChatGPT models or a running Ollama service for local models.
  • Setup involves configuring API keys or Ollama in plugin settings.
  • Official installation guide: Obsidian Community Plugins

Highlighted Details

  • Supports multiple AI providers: OpenAI (ChatGPT, GPT-3), AI21 (Jurassic-2), Goose.ai, Groq, and Ollama.
  • "Presets" feature allows saving and recalling custom configurations as global editor commands.
  • Mobile support includes adding an "Accept completion" command to the toolbar.
  • Groq is highlighted as a fast, free, and generous provider.

Maintenance & Community

  • Project is a passion project; financial support is optional.
  • Users can submit issues on the GitHub repository for installation or usage problems.

Licensing & Compatibility

  • License details are not explicitly stated in the README.
  • Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

The README does not specify any limitations, known bugs, or deprecation warnings. The project's status (e.g., beta, stable) is also not explicitly mentioned.

Health Check
Last commit

1 year ago

Responsiveness

1 week

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

Explore Similar Projects

Feedback? Help us improve.