🔍 Copilot for Obsidian

Copilot for Obsidian is an open-source LLM interface right inside Obsidian. It has a minimalistic design and is straightforward to use.

• 💬 Chat UI in Obsidian with support for countless models, just BYO API key or use local models with LM Studio or Ollama.
• 🛠️ Prompt AI with Copilot commands or your own custom prompts at the speed of thought.
• 🧠 Talk to your entire vault for answers and insights.
• 🚀 Turbocharge your Second Brain with powerful AI agents (Copilot Plus).

My goal is to make it the ultimate AI assistant that truly understands your personal knowledge base while being privacy-focused.

It has a local index that powers the question-answering. Your notes are always stored on your own device and nowhere else! More features are under construction. Stay tuned!

If you enjoy Copilot for Obsidian, please consider sponsoring this project, or donate by clicking the button below. It will help me keep this project going to build toward a privacy-focused AI experience. Thank you!

SPECIAL THANKS TO OUR TOP SPONSORS:
@mikelaaron, @pedramamini, @Arlorean, @dashinja, @azagore, @MTGMAD, @gpythomas, @emaynard, @scmarinelli, @borthwick, @adamhill, @gluecode, @rusi, @timgrote, @JiaruiYu-Consilium, @ddocta, @AMOz1, @chchwy, @pborenstein, @GitTom, @kazukgw, @mjluser1, @joesfer, @rwaal, @turnoutnow-harpreet, @dreznicek, @xrise-informatik, @jeremygentles, @ZhengRui, @bfoujols, @jsmith0475, @pagiaddlemon, @sebbyyyywebbyyy, @royschwartz2, @vikram11, @amiable-dev, @khalidhalim, @DrJsPBs, @chishaku, @Andrea18500, @shayonpal, @rhm2k, @snorcup, @JohnBub, @obstinatelark, @jonashaefele, @vishnu2kmohan

Changelog

🚀 v2.8.0 Revamped Settings, Inline Edit Dialog, and Relevant Notes in Copilot Chat! 🚀

As we are fast approaching the official launch of Copilot Plus, we've revamped the settings page to make it more user-friendly and intuitive. Please share your feedback on the new settings page! We've also implemented a brand new experience for easier inline editing of selected text using Copilot commands such as simplify, translate, fix grammar, etc. You can now select text and see a list of them in your right-click context menu. (Thanks to @Emt-lin and @zeroliu for the contribution!)

We've introduced Relevant Notes in Copilot Chat in the previous release. You can now see the collapsible Relevant Notes section at the top of the chat UI. It uses the same Copilot index you create for Vault QA. "Relevance" is determined by Copilot's own special algorithm based on hybrid search and Obsidian's note graph similarity, it is not just vector similarity. You can clearly see ranking factors such as the level of similarity and whether it has a direct link or backlink to the current note. You can also add any relevant note to chat with one click. The entire feature is developed by our great @zeroliu, one of our top contributors 💪. Enjoy!

🤖 v2.7.0 Copilot Plus (alpha) demo video - AI Agent for Obsidian! 🚀

Copilot Plus is a brand new mode that brings powerful agentic capabilities to Obsidian. Think of it as Cursor inside Obsidian but optimized for PKM use cases instead of coding.

Check out the demo video below for the first sneak peak of what Copilot Plus can do. It is under active development so expect more features to come very soon!

🛠️ Features

• Engage with numerous LLMs seamlessly within Obsidian via the Copilot Chat window.
• Access OpenAI or Anthropic models without purchasing ChatGPT Plus or Claude Pro—simply use your own API key (stored locally) and pay as you go for the best value.
• Choose from a variety of models, including OpenAI, Azure, Google, Anthropic, OpenRouter, Groq, Cohere, or any third-party models with OpenAI-compatible APIs via Custom Model.
• Customize parameters like LLM temperature, max tokens, and conversation context to suit your needs (be mindful of API costs).
• Utilize local models powered by LM Studio and Ollama.
• Easily copy, edit, or insert any message to your note with a single click.
• Save or load entire conversations to or from a note.
• To mention a note in Copilot Chat, simply type [[ and provide the note title.
• Use simple commands to simplify, emojify, summarize, translate, change tone, fix grammar, rewrite into a tweet/thread, count tokens, and more.
• Take advantage of powerful User Custom Prompts! You can add, apply, edit, and delete your custom prompts, all stored locally in your Obsidian vault as markdown. Trigger any custom prompt with a simple / in the chat input!
• Interact with your entire vault using "Vault QA" mode. Ask questions and receive cited responses!
• All QA modes leverage retrieval augmentation with a local index, ensuring your data isn't sent to a cloud-based vector search service.
• Copilot Plus (beta): supercharge your second brain with a powerful AI agent right inside your Obsidian vault. Learn more here.

Chat and Vault QA modes are completely free to use. Copilot Plus is currently in beta, buy now to lock in the lowest price!

Model Providers

OpenAI, Anthropic, Azure OpenAI, Google Gemini, Cohere, OpenRouter, GROQ, and any 3rd Party Models with OpenAI-Compatible API are supported. You can easily add them via Custom Model in Copilot settings.

LM Studio and Ollama are supported for local models. Please check out the super simple setup guide here. Don't forget to flex your creativity in custom prompts using local models!

🤗 New to Copilot? Quick Guide for Beginners

The simplest way to get started is to get an OpenAI API key (with payment method set up with OpenAI) and set it in the Copilot settings. Then simply pick gpt-4o or gpt-4o-mini in the model dropdown to start chatting. Make sure to set your default chat and embedding model in the first tab of Copilot settings.

For plus users, you can keep the embedding model as is copilot-plus-small (it's a smaller but better model than the OpenAI large, and it's covered by your subscription). For free users, you can set the embedding model to text-embedding-3-small as the starting point, and explore other embedding models once you get a sense of how this works.

Please check out the documentation for more details.

Try going through all the Copilot commands in the command palette, and see what they do. You can also checkout my youtube channel for previous demos.

🔧 Adding Models

Add model using the "Custom Model" form.

• When you add any model from the existing list of providers, there's no need to provide the URL.
• When you add your own custom models, you can add them with the endpoint URL as long as they have OpenAI-compatible API.

You can also use your own system prompt, choose between different embedding providers for Vault QA and more.

💬 User Custom Prompt: Create as Many Copilot Commands as You Like!

You can add, apply, edit and delete your own custom Copilot commands, all persisted in your local Obsidian environment!
Check out this demo video below!

🧠 Advanced Custom Prompt! Unleash your creativity and fully leverage the long context window!

This video shows how Advanced Custom Prompt works. This form of templating enables a lot more possibilities with long context window models. If you have your own creative cool use cases, don't hesitate to share them in the discussion or in the youtube comment section!

⚙️ Installation (recommended)

• Open Community Plugins settings page, click on the Browse button.
• Search for "Copilot" in the search bar and find the plugin with this exact name.
• Click on the Install button.
• Once the installation is complete, enable the Copilot plugin by toggling on its switch in the Community Plugins settings page.

Now you can see the chat icon in your leftside ribbon, clicking on it will open the chat panel on the right! Don't forget to provide your API keys in settings before using the plugin!

⛓️ Manual Installation

• Go to the latest release
• Download main.js, manifest.json, styles.css and put them under .obsidian/plugins/obsidian-copilot/ in your vault
• Open your Obsidian settings > Community plugins, and turn on Copilot.

📣 Again, please always be mindful of the API cost if you use expensive models with a long context!

🤔 FAQ (please read before submitting an issue)

  curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=VERSION\
    -H "Content-Type: application/json" \
    -H "api-key: YOUR_API_KEY" \
    -d "{
    \"prompt\": \"Once upon a time\",
    \"max_tokens\": 5
  }"

When opening an issue, please follow the issue template and include relevant console logs. You can go to Copilot's settings and turn on "Debug mode" at the bottom for more console messages. On Mac, you can open the console by pressing Cmd+Opt+I. On Windows, you can open the console by pressing Ctrl+Shift+I.

Copilot Plus Disclosure

Copilot Plus is a premium product of Brevilabs LLC and it is not affiliated with Obsidian. It offers a powerful agentic AI integration into Obsidian. Please check out our website obsidiancopilot.com for more details!

• An account and payment are required for full access.
• Copilot Plus requires network use to faciliate the AI agent.
• Copilot Plus does not access your files without your consent.
• Copilot Plus collect server-side telemetry to improve the product. Please see the privacy policy on the website for more details.
• The frontend code of Copilot plugin is fully open-source. However, the backend code facilitating the AI agents is close-sourced and proprietary.
• We offer a full refund if you are not satisfied with the product within 14 days of your purchase, no questions asked.

🙏 Thank You

If you share my vision, please consider sponsoring this project or buying me some coffees!

Please also help spread the word by sharing about the Copilot for Obsidian Plugin on Twitter/X, Reddit, or any other social media platform you use.

You can find me on Twitter/X @logancyang.