Introducing Obsidian Companion
Overview
Obsidian Companion is a user-friendly plugin for Obsidian, the popular note-taking and personal knowledge management tool. By integrating sophisticated AI-powered autocomplete functionalities, Companion redefines the way users can manage their notes. It utilizes advanced AI models, such as OpenAI's GPT-3 and GPT-3.5, including ChatGPT, as well as locally hosted models like Ollama. This means that users can receive intelligent suggestions tailored to the way they write, whether it's to complete words, phrases, or entire sentences.
The integration is designed to blend seamlessly into the user's workflow, offering suggestions in a discreet manner similar to how GitHub Copilot operates. The AI suggestions can be accepted or ignored, offering flexibility and enhancing the user's productivity and creativity. Companion is especially useful for students, researchers, and professionals who wish to elevate their note-taking and knowledge management skills.
How to Get Started
To start using Companion, users can easily install it from the Obsidian Community Plugin Directory by following these steps:
- Navigate to the Community Plugins settings in Obsidian.
- Search for Companion and click the Install button.
- Once installed, confirm the setup and enable the plugin through the settings page.
Using the AI Features
For those interested in taking advantage of the AI models, setting up is straightforward:
- Secure an API key from the OpenAI API Keys portal.
- Enter this API key in the Companion plugin settings inside Obsidian.
- Activate the autocomplete feature by using the command palette (
Ctrl/Cmd + P) and selecting "Toggle Completion". - As suggestions appear, users can hit the
Tabkey to accept suggested completions.
For mobile use, a similar setup process applies, with tailored instructions for accessing options via the app's toolbar.
Additional Features
Presets
Companion includes a "Presets" feature, allowing users to save and quickly switch between different configurations. By naming and saving specific settings as presets, users can access them through the command palette, enabling quick adaptation to varying editing needs.
Model Providers
Besides OpenAI, Companion supports completion from other models like AI21's Jurassic-2 and goose.ai. The plugin is designed to be flexible, with additional models being added in the future.
Groq and Ollama Support
Users can choose model providers such as Groq, which offers generous usage without cost (as of May 2024), or Ollama for local model hosting, reducing latency and cost.
Community and Support
The development of Obsidian Companion is a passion project. While no financial gain is expected, users are welcome to support the project by buying the developer a coffee through a donation page. The developer appreciates all forms of support and feedback, which can also include opening issues or suggesting enhancements on the plugin's GitHub repository.
In summary, Obsidian Companion enhances note-taking in Obsidian with AI-powered features that are intuitive and customizable, supporting users in achieving more efficient knowledge management.