explaingit

logancyang/obsidian-copilot

6,979TypeScriptAudience · generalComplexity · 2/5Setup · easy

TLDR

An Obsidian plugin that adds AI chat to your notes, lets you ask natural-language questions across your entire vault, and works with any AI provider using your own API key so your notes stay private.

Mindmap

mindmap
  root((repo))
    What it does
      AI chat in Obsidian
      Search your vault
      Bring your own API key
    Free features
      Chat with notes
      Vault-wide search
      URL and PDF questions
      Image understanding
    Paid features
      Autonomous agent mode
      Long-term memory
      Date-filtered search
    Setup
      Install from plugin browser
      Add API key in settings
      No extra software needed
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Ask questions across your entire Obsidian vault in plain English and get answers that cite your own notes.

USE CASE 2

Paste a YouTube link or webpage URL into the chat and ask questions about it without leaving Obsidian.

USE CASE 3

Use command palette AI actions to summarize, rewrite, or translate a selected block of text in a note.

Tech stack

TypeScriptObsidian

Getting it running

Difficulty · easy Time to first run · 5min

Requires a paid API key from your chosen AI provider such as OpenAI or Anthropic, free-tier API keys may hit rate limits quickly.

In plain English

Copilot for Obsidian is a plugin that adds AI chat capabilities to Obsidian, a popular note-taking app where people store and connect their personal knowledge. Instead of relying on a single AI service, this plugin lets you bring your own API key from any compatible provider, including OpenAI, Anthropic, Google, and others. Your notes stay on your own computer, and the plugin sends only what you choose to the AI. The basic free tier lets you chat with your notes by referencing them in conversation, search across your entire vault by typing a question, and use a command palette for quick AI actions on selected text. You can paste in a webpage URL, a YouTube video link, or a PDF and ask questions about it. Starting from version 3, image understanding and a chat context menu are also available to free users without any paid subscription. The paid Copilot Plus tier adds an autonomous agent mode. In this mode the AI decides on its own which tools to use, such as searching your notes, doing a web search, or summarizing a video, without you having to specify. It also includes long-term memory, meaning the agent can retain information about you across sessions, and the ability to filter searches to a specific date window for more precise results. Setup is done through Obsidian's community plugin browser: search for Copilot, install it, then enter an API key from your chosen AI provider in the plugin settings. No separate software installation is needed. The plugin is written in TypeScript and the source code is publicly available. The project's stated goal is to avoid locking users into any one AI platform. The developer frames it as a way to own your AI assistant outright rather than depending on a subscription that could change or disappear.

Copy-paste prompts

Prompt 1
I have installed Copilot for Obsidian with my Anthropic API key. How do I search my entire vault by asking a natural language question instead of using keyword search?
Prompt 2
Using Copilot for Obsidian, what command palette commands are available to summarize, rewrite, or translate a block of selected text in my notes?
Prompt 3
I want to ask Copilot for Obsidian questions about a PDF saved in my vault. What are the steps to include that PDF as context in a chat conversation?
Prompt 4
How does the autonomous agent mode in Copilot Plus decide which tools to use, and what kinds of multi-step tasks is it best suited for in a personal knowledge base?
Open on GitHub → Explain another repo

← logancyang on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.