41dc2e7835
* feat(agent): project-context freshness v1 (minimal watcher + coarse note) Detect changes to a project's declared context sources with a debounced vault watcher, mark the project's materialized context dirty via an epoch-salted revision key, and surface a single coarse "sources may have changed" note to ongoing and resumed sessions. Stale empty landings are no longer reused on re-entry, and pending watcher events are flushed at send time. This is the conservative v1 the maintainer asked for on #2658: broad dirty notification now, with per-path/binary deltas, resume manifest re-delivery, and richer source summaries deferred to separate PRs. - ProjectContentTracker: debounced create/modify/delete/rename watcher, coarse per-project scope match (bidirectional folder subtree, conservative tag/folder rules, dead-path + internal-file exclusion), per-project content epoch. - Epoch-salted dirty key + materializer revisionKey so a content edit supersedes an in-flight run reading the old content instead of joining it. - AgentSession: optional sync updates hook injected once per turn, acked only after the backend accepts (fan-out never acks); GLOBAL sessions get no hook. - Resumed sessions force one coarse note on first send; detached stale landings are excluded from reuse. * fix(agent): close v1 freshness review findings Review pass on the v1 changeset surfaced six items; five fixed, one kept. - Config-source changes now advance the shared content epoch (via ProjectContentTracker.bumpEpoch) before marking dirty, so an ongoing session gets the coarse note when a config edit adds a URL/PDF/folder it can't see. - Flush pending watcher events before the empty-landing reuse decision in enterProject and before the epoch/dirty snapshot in createSession, so an edit-then-immediately-reopen can't reuse a stale landing or capture an old epoch. - Tag-declaring projects are now dirtied on folder ops and on a .md->.txt rename (markdown relevance checked on both rename sides), and the internal-path guard runs before the tag shortcut so a project.md/AGENTS.md edit no longer sprays notes. - The fresh-session cursor seed is monotonic (never regresses a higher acked epoch). Kept: the coarse-note wording keeps its capitalized, punctuated sentence form (semantically identical to the maintainer's descriptive phrasing). * fix(agent): close same-dimension siblings from freshness verify pass A verification pass on the review fixes surfaced two open cells in the two recurring dimensions plus one residual timing window; all closed here. - event x projection: a folder CREATE (empty directory, no members) no longer dirties any project. Snapshot the vault event kind and gate folder-membership handling (tag fallback + folder/note/extension match) to rename/delete only. - carried-state x boundary: resume now flushes pending watcher events before reading the revision key, so it can't join a stale in-flight materialization and rehydrate the backend with stale searchable roots. - The fresh-session delivery-cursor seed moved off session.ready onto contextReady settlement, so it lands before the session becomes sendable (the post-newSession confirmSeededSelection window) — no redundant first-turn note. The dirty CLEAR stays on session.ready so a failed backend startup keeps the project dirty. * docs(agent): design-note the folder-create no-op in the content tracker Close the last event×projection cell from the verify sweep deliberately: a folder CREATE — even of a folder that exactly matches a declared folderPattern — stays a no-op. An empty folder has nothing to materialize, ongoing sessions don't re-mount roots mid-conversation in v1, and an empty landing's manifest equals a fresh one's; the first file inside it dirties via the file path and self-heals. Documented so a future review doesn't re-litigate it. * fix(agent): dirty on creating an exactly-declared folder source The prior design-noted no-op was based on a false premise: resolveFolderPaths turns a declared-but-nonexistent folder from a raw vaultPath into a real manifest entry (absPath) plus, when out-of-cwd, a mounted additionalDirectories search root once it exists. So creating an exactly-declared folder DOES change the manifest, and reusing a stale empty landing would leave the backend without that root (a later file inside it can mark dirty but can't add a root to an already-open session). Dirty a project when a folder CREATE path exactly equals one of its declared folder patterns; a parent/child create resolves no different pattern, so the tag/note/extension broad fallbacks stay off for CREATE. * docs(agent): document accepted in-place stale-manifest window The send-time freshness hook only emits the coarse note; it does not rebuild a live session's projectContextBlock or additionalDirectories. Lock that boundary in a DESIGN NOTE at getProjectContextUpdates so the in-place first-send staleness (recovered on next/re-entered session via the empty-landing gate) isn't re-litigated. Comment-only; no behavior change. |
||
|---|---|---|
| .claude | ||
| .cursor/rules | ||
| .github | ||
| .husky | ||
| __mocks__ | ||
| designdocs | ||
| docs | ||
| images | ||
| scripts | ||
| src | ||
| typings | ||
| .editorconfig | ||
| .gitignore | ||
| .npmrc | ||
| .prettierrc | ||
| AGENTS.md | ||
| CLAUDE.md | ||
| components.json | ||
| CONTRIBUTING.md | ||
| esbuild.config.mjs | ||
| eslint.config.mjs | ||
| jest.config.js | ||
| jest.setup.js | ||
| knip.json | ||
| LICENSE | ||
| local_copilot.md | ||
| manifest.json | ||
| nodeModuleShim.mjs | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| RELEASES.md | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| version-bump.mjs | ||
| versions.json | ||
| wasmPlugin.mjs | ||
Copilot for Obsidian
The Ultimate AI Assistant for Your Second Brain
Documentation | Youtube | Report Bug | Request Feature
The What
Copilot for Obsidian is your in‑vault AI assistant with chat-based vault search, web and YouTube support, powerful context processing, and ever-expanding agentic capabilities within Obsidian's highly customizable workspace - all while keeping your data under your control.
The Why
Today's AI giants want you trapped: your data on their servers, prompts locked to their models, and switching costs that keep you paying. When they change pricing, shut down features, or terminate your account, you lose everything you built.
We are building the opposite. Our goal is to create a portable agentic experience with no provider lock-in. Data is always yours. Use whatever LLM you like. Imagine that a brand new model drops, you run it on your own hardware, and it already knows about you (long-term memory), knows how to run the same commands and tools you have defined over time (as just markdown files), and becomes the thought partner and assistant that you own. This is AI that grows with you, not a subscription you're hostage to.
This is the future we believe in. If you share this vision, please support this project!
Key Features
- 🔒 Your data is 100% yours: Local search and storage, and full control of your data if you use self-hosted models.
- 🧠 Bring Your Own Model: Tap any OpenAI-compatible or local model to uncover insights, spark connections, and create content.
- 🖼️ Multimedia understanding: Drop in webpages, YouTube videos, images, PDFs, EPUBS, or real-time web search for quick insights.
- 🔍 Smart Vault Search: Search your vault with chat, no setup required. Embeddings are optional. Copilot delivers results right away.
- ✍️ Composer and Quick Commands: Interact with your writing with chat, apply changes with 1 click.
- 🗂️ Project Mode: Create AI-ready context based on folders and tags. Think NotebookLM but inside your vault!
- 🤖 Agent Mode (Plus): Unlock an autonomous agent with built-in tool calling. No commands needed. Copilot automatically triggers vault, web searches or any other relevant tool when relevant.
Copilot's Agent can call the proper tools on its own upon your request.
Table of Contents
- The What
- The Why
- Key Features
- Copilot V3 is a New Era 🔥
- Why People Love It ❤️
- Get Started
- Usage
- Need Help?
- FAQ
- 🙏 Thank You
- Copilot Plus Disclosure
- Authors
Copilot V3 is a New Era 🔥
After months of hard work, we have revamped the codebase and adopted a new paradigm for our agentic infrastructure. It opens the door for easier addition of agentic tools (MCP support coming). We will provide a new version of the documentation soon. Here is a couple of new things that you cannot miss!
- FOR ALL USERS: You can do vault search out-of-the-box without building an index first (Indexing is still available but optional behind the "Semantic Search" toggle in QA settings).
- FOR FREE USERS: Image support and chat context menu are available to all users starting from v3.0.0!
- FOR PLUS USERS: Autonomous agent is available with vault search, web search, youtube, composer and soon a lot other tools! Long-term memory is also a tool the agent can use by itself starting from 3.1.0!
Read the Changelog.
Why People Love It ❤️
- "Copilot is the missing link that turns Obsidian into a true second brain. I use it to draft investment memos with text, code, and visuals—all in one place. It’s the first tool that truly unifies how I search, process, organize, and retrieve knowledge without ever leaving Obsidian. With AI-powered search, organization, and reasoning built into my notes, it unlocks insights I’d otherwise miss. My workflow is faster, deeper, and more connected than ever—I can’t imagine working without it." - @jasonzhangb, Investor & Research Analyst
- "Since discovering Copilot, my writing process has been completely transformed. Conversing with my own articles and thoughts is the most refreshing experience I’ve had in decades.” - Mat QV, Writer
- "Copilot has transformed our family—not just as a productivity assistant, but as a therapist. I introduced it to my non‑technical wife, Mania, who was stressed about our daughter’s upcoming exam; within an hour, she gained clarity on her mindset and next steps, finding calm and confidence." - @screenfluent, A Loving Husband
Get Started
Install Obsidian Copilot
- Open Obsidian → Settings → Community plugins.
- Turn off Safe mode (if enabled).
- Click Browse, search for “Copilot for Obsidian”.
- Click Install, then Enable.
Set API Keys
Free User
- Go to Obsidian → Settings → Copilot → Basic and click Set Keys.
- Choose your AI provider(s) (e.g., OpenRouter, Gemini, OpenAI, Anthropic, Cohere) and paste your API key(s). OpenRouter is recommended.
Copilot Plus/Believer
- Copy your license key at your dashboard. Don’t forget to join our wonderful Discord community!
- Go to Obsidian → Settings → Copilot → Basic and paste the key into in the Copilot Plus card.
Usage
Free User
Chat Mode: reference notes and discuss ideas with Copilot
Use @ to add context and chat with your note.
Ask Copilot:
Summarize Q3 Retrospective and identify the top 3 action items for Q4 based on the notes in {01-Projects}.
Vault QA Mode: chat with your entire vault
Ask Copilot:
What are the recurring themes in my research regarding the intersection of AI and SaaS?
Copilot's Command Palette
Copilot's Command Palette puts powerful AI capabilities at your fingertips. Access all commands in chat window via / or via
right-click menu on selected text.
Add selection to chat context
Select text and add it to context. Recommend shortcut: ctrl/cmd + L
Quick Command
Select text and apply action without opening chat. Recommend shortcut: ctrl/cmd + K
Edit and Apply with One Click
Select text and edit with one RIGHT click.
Create your Command
Create commands and workflows in Settings → Copilot → Command → Add Cmd.
Command Palette in Chat
Type / to use Command Palette in chat window.
Relevant Notes: notes suggestions based on semantic similarity and links
Open it from the command palette (Open Relevant Notes) to get its own pane that surfaces related content and links for whatever note you're viewing.
Use it to quickly reference past research, ideas, or decisions—no need to search or switch tabs.
Copilot Plus/Believer
Copilot Plus brings powerful AI agentic capabilities, context-aware actions and seamless tool integration—built to elevate your knowledge work in Obsidian.
Get Precision Insights From a Specific Time Window
In agent mode, ask copilot:
What did I do last week?
Agent Mode: Autonomous Tool Calling
Copilot's agent automatically calls the right tools—no manual commands needed. Just ask, and it searches the web, queries your vault, and combines insights seamlessly.
Ask Copilot in agent mode:
Research web and my vault and draft a note on AI SaaS onboarding best practices.
Understand Images in Your Notes
Copilot can analyze images embedded in your notes—from wireframes and diagrams to screenshots and photos. Get detailed feedback, suggestions, and insights based on visual content.
Ask Copilot to analyze your wireframes:
Analyze the wireframe in UX Design - Mobile App Wireframes and suggest improvements for the navigation flow.
One Prompt, Every Source—Instant Summaries from PDFs, Videos, and Web
In agent mode, ask Copilot
*Compare the information about [Agent Memory] from this youtube video: [URL], this PDF [file], and @web[search results]. Start with your
conclusion in bullet points in your response*
Need Help?
- Check the documentation for setup guides, how-tos, and advanced features.
- Watch Youtube for walkthroughs.
- If you're experiencing a bug or have a feature idea, please follow the steps below to help us help you faster:
- 🐛 Bug Report Checklist
- ☑️Use the bug report template when reporting an issue
- ☑️Enable Debug Mode in Copilot Settings → Advanced for more detailed logs
- ☑️Open the dev console to collect error messages:
- Mac: Cmd + Option + I
- Windows: Ctrl + Shift + I
- ☑️Turn off all other plugins, keeping only Copilot enabled
- ☑️Attach relevant console logs to your report
- ☑️Submit your bug report here
- 💡 Feature Request Checklist
- ☑️Use the feature request template for requesting a new feature
- ☑️Clearly describe the feature, why it matters, and how it would help
- ☑️Submit your feature request here
- 🐛 Bug Report Checklist
FAQ
Why isn’t Vault search finding my notes?
If you're using the Vault QA mode (or the tool @vault in Plus), try the following:
- Ensure you have a working embedding model from your AI model's provider (e.g. OpenAI). Watch this video: AI Model Setup (API Key)
- Ensure your Copilot indexing is up-to-date. Watch this video: Vault Mode
- If issues persist, run Force Re-Index or use List Indexed Files from the Command Palette to inspect what's included in the index.
- ⚠️ Don’t switch embedding models after indexing—it can break the results.
Why is my AI model returning error code 429: ‘Insufficient Quota’?
Most likely this is happening because you haven’t configured billing with your chosen model provider—or you’ve hit your monthly quota. For example, OpenAI typically caps individual accounts at $120/month. To resolve:
- ▶️ Watch the “AI Model Setup” video: AI Model Setup (API Key)
- 🔍 Verify your billing settings in your OpenAI dashboard
- 💳 Add a payment method if one isn’t already on file
- 📊 Check your usage dashboard for any quota or limit warnings
If you’re using a different provider, please refer to their documentation and billing policies for the equivalent steps.
Why am I getting a token limit error?
Please refer to your model provider’s documentation for the context window size.
⚠️ If you set a large max token limit in your Copilot settings, you may encounter this error.
- Max tokens refers to completion tokens, not input tokens.
- A higher output token limit means less room for input!
🧠 Behind-the-scenes prompts for Copilot commands also consume tokens, so:
- Keep your message length short
- Set a reasonable max token value to avoid hitting the cap
💡 For QA with unlimited context, switch to the Vault QA mode in the dropdown (Copilot v2.1.0+ required).
🙏 Thank You
If you share the vision of building the most powerful AI agent for our second brain, consider sponsoring this project or buying me a coffee. Help spread the word by sharing Copilot for Obsidian on Twitter/X, Reddit, or your favorite platform!
Acknowledgments
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
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 facilitate the AI agent.
- Privacy & Data Handling:
- Free tier: Your messages and notes are sent only to your configured LLM provider (OpenAI, Anthropic, Google, etc.). Nothing goes to Brevilabs servers.
- Plus tier: Messages go to your configured LLM provider. File conversions (PDF, DOCX, EPUB, images, etc.) are processed by Brevilabs servers only when you explicitly trigger these features via
@commands. - Processing vs. Retention: We process your data to deliver the feature you requested, then discard it. No message content, file uploads, or documents are retained on our servers after processing.
- User ID: A randomly generated UUID is sent with Plus API requests for service delivery (license abuse prevention, rate limiting) but is not used for user tracking, profiling, or analytics.
- 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.
Authors
Brevilabs Team | Email: logan@brevilabs.com | X/Twitter: @logancyang