obsidian-plugin/logancyang_obsidian-copilot
1
0
Fork 0
mirror of https://github.com/logancyang/obsidian-copilot.git synced 2026-07-22 07:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

embed demo videos in README; replace old get started sections with a condensed one

Browse source
This commit is contained in:
ichts 2025-09-22 23:29:46 +08:00
parent 0512e21471
commit e70cc7d2b2
1 changed files with 56 additions and 215 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

271
README.md
View file

@ -26,18 +26,46 @@ Copilot for Obsidian is your ultimate in‑vault AI assistant with chat-based va
- **🔒 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.
- **🖼️ 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.
<p align="center">
<img src="./images/product-ui-screenshot.jpeg" alt="Product UI screenshot" width="800"/>
</p>
**Chat Mode**
<p align="center">
<video width="700" controls style="height: auto; max-width: 100%;">
<source src="https://i.imgur.com/3yuXSH5.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</p>
**Vault QA**
<p align="center">
<video width="700" controls style="height: auto; max-width: 100%;">
<source src="https://i.imgur.com/4uB3Z3u.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</p>
**Agentic Mode**
<p align="center">
<video width="700" controls style="height: auto; max-width: 100%;">
<source src="https://i.imgur.com/UnXDUn1.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</p>
<p align="center">
<em>Copilot's Agent can call the proper tools on its own upon your request.</em>
</p>
<p align="center">
<img src="./images/product-ui-screenshot.jpeg" alt="Product UI screenshot" width="800"/>
</p>
## Copilot V3 is a New Era 🔥
@ -55,227 +83,38 @@ Read the [Changelog](https://github.com/logancyang/obsidian-copilot/releases/tag
- *"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 in 5 Minutes**
## Get Started
### FREE Product Features
### Install Obsidian Copilot
**🔌 Install Copilot in Community Plugins in Obsidian**
1. Open **Obsidian → Settings → Community plugins**.
2. Turn off **Safe mode** (if enabled).
3. Click **Browse**, search for **“Copilot for Obsidian”**.
4. Click **Install**, then **Enable**.
**🔑 Set Up Your AI Model (API Key)**
### Set API Keys
- To start using Copilot AI features, you'll need access to an AI model of your choice.
**Free User**
1. Go to **Obsidian → Settings → Copilot → Basic** and click **Set Keys**.
2. Choose your AI provider(s) (e.g., **OpenRouter, Gemini, OpenAI, Anthropic, Cohere**) and paste ****your ****API ****key(s)**. OpenRouter is recommended.**
**Copilot Plus/Believer**
1. Copy your license key at your [dashboard](https://www.obsidiancopilot.com/en/dashboard). *Don’t forget to join our wonderful Discord community!*
2. Go to **Obsidian → Settings → Copilot → Basic** and paste the key into in the **Copilot Plus** card.
<p align="center">
<a href="https://www.youtube.com/watch?v=mzMbiamzOqM" target="_blank">
<img src="./images/AI-Model-Setup.png" alt="AI Model API Key" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
<video width="700" controls style="height: auto; max-width: 100%;">
<source src="https://imgur.com/a/2YVc0tK" type="video/mp4">
Your browser does not support the video tag.
</video>
</p>
**📖** **Chat Mode: Summarize Specific Notes**
- 🧠 **Use When:** You want to reference specific notes or folders, generate content, or talk through ideas with Copilot like a knowledgeable thought partner.
### Start Using Copilot
- 💭 **In `Chat` mode, ask Copilot:**
> _"Summarize [[Meeting Notes – March]] and create a follow-up task list based on notes in {projects}."_
<p align="center">
<a href="https://www.youtube.com/watch?v=idit7nCqEs0" target="_blank">
<img src="./images/Chat-Mode.png" alt="Chat Mode" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
**📖** **Vault QA Mode: Chat With Your Entire Vault**
- 🧠 **Use When:** You want to search your vault for patterns, ideas, or facts without knowing exactly where the information is stored.
- 💭 **In `Vault QA` mode, ask Copilot:**
> _"What insights can I gather about the benefits of journaling from all of my notes?"_
- 💡 **Tip:** Replace _the benefits of journaling_ with any topic mentioned in your notes to get more precise results.
<p align="center">
<a href="https://www.youtube.com/watch?v=hBLMWE8WRFU" target="_blank">
<img src="./images/Vault-Mode.png" alt="Vault Mode" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
**📖 Edit and Apply with One Click**
- 🧠 **Use When:** You want to quickly fix grammar, spelling or wording directly in your notes—without switching tabs or manually rewriting.
- 💭 **Select the text** and **edit with one RIGHT click**
- 💡 **Tip:** Set up and customize your right-click menu with common actions you use often, like _"Summarize"_, _"Simplify Language"_, or _"Translate to Formal Tone"_—so you can apply them effortlessly while you write.
<p align="center">
<a href="https://www.youtube.com/watch?v=hSmRnmEVoec" target="_blank">
<img src="./images/One-Click-Commands.png" alt="One-Click Commands" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
**📖 Automate your workflow with the Copilot Prompt Palette**
- 🧠 **Use When:** You want to speed up repetitive tasks like summarizing, rewriting, or translating without typing full prompts every time.
- 💭 Type / to use Prompt Palette
- 💡 **Tip:** Create shortcuts for your most-used actions—like _"Translate to Spanish"_ or _"Draft a blog post outline"_—and trigger them instantly with typing / !
<p align="center">
<a href="https://www.youtube.com/watch?v=9YzY2OJ54wM" target="_blank">
<img src="./images/Prompt-Palette.png" alt="Prompt Palette" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
**📖 Stay in flow with the Relevant Notes**
- 🧠 **Use When:** You're working on a note and want to pull in context or insights from related notes—without breaking your focus.
- 💭 Appears automatically when there's useful related content.
- 💡 **Tip:** Use it to quickly reference past research, ideas, or decisions—no need to search or switch tabs.
<p align="center">
<a href="https://www.youtube.com/watch?v=qapQD7jD3Uk" target="_blank">
<img src="./images/Relevant-Notes.png" alt="Relevant Notes" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
### Level Up with Copilot Plus and Beyond
Copilot Plus brings powerful AI agentic capabilities, context-aware actions and seamless tool integration—built to elevate your knowledge work in Obsidian.
🆙 **Upgrade to Copilot Plus**
First, go to https://www.obsidiancopilot.com/en to subscribe to Copilot Plus. Then, set up Copilot Plus License Key in Obsidian.
<p align="center">
<a href="https://www.youtube.com/watch?v=pPfWKZnNYhA" target="_blank">
<img src="./images/Copilot-Plus-Setup.png" alt="Copilot Plus Setup" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
❔Community is at the heart of everything we build. Join us on Discord for updates, priority support, and a voice in shaping the best AI products for your experience.
<p align="center">
<img src="./images/discord-support.png" alt="Discord support screenshot" width="700"/>
</p>
**📖 Get Precision Insights From a Specific Time Window**
- 🧠 **Use When:** You want to quickly review tasks, notes, or ideas from a specific time range without manually digging through files.
- 💭 **In Chat mode, ask Copilot:**
> _"Give me a recap of everything I captured last week."_
- 💡 **Tip:** Try variations like _"Summarize my highlights from August 11 through August 22"_ for even more insights.
<p align="center">
<a href="https://www.youtube.com/watch?v=sXP2sjvrqtI" target="_blank">
<img src="./images/Time-Based-Queries.png" alt="Time-Based Queries" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
**📖 One Prompt, Every Source—Instant Summaries from PDFs, Videos, and Web**
- 🧠 **Use When:** You want to combine information from multiple formats—documents, videos, web pages, and images—into one concise, actionable summary.
- 💭 **In PLUS mode, ask Copilot:**
> "Please write a short intro of Kiwi birds based on the following information I collected about this animal.
> @youtube Summarize [](https://www.youtube.com/watch?v=tZ2jm_UPc6c&t=417s)[https://www.youtube.com/watch?v=tZ2jm_UPc6c&t=417s](https://www.youtube.com/watch?v=ABTfc5wUT1U)
> in a short paragraph.
> @websearch where can I find Kiwi birds?
> Summarize https://www.doc.govt.nz/nature/native-animals/birds/birds-a-z/kiwi/ in 300 words.“
- 🛠️ **Add PDFs and Images as Context to Enrich Your Learning**
- 💡 _Tip: For large PDFs, reference specific sections to focus the AI's attention._
<p align="center">
<a href="https://www.youtube.com/watch?v=WXoOZmMSHVE" target="_blank">
<img src="./images/One-Prompt-Every-Source.png" alt="One Prompt, Every Source" width="700" height="394">
</a><br>
<em>Click the image to watch the video on YouTube</em>
</p>
# **💡 Need Help?**
- Check the [documentation](https://www.obsidiancopilot.com/en/docs) for setup guides, how-tos, and advanced features.
- Watch [Youtube](https://www.youtube.com/@loganhallucinates) 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](https://github.com/logancyang/obsidian-copilot/issues/new?template=bug_report.md) 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](https://github.com/logancyang/obsidian-copilot/issues/new?template=bug_report.md)
- 💡 Feature Request Checklist
- ☑️Use the [feature request template](https://github.com/logancyang/obsidian-copilot/issues/new?template=feature_request.md) for requesting a new feature
- ☑️Clearly describe the feature, why it matters, and how it would help
- ☑️Submit your feature request [here](https://github.com/logancyang/obsidian-copilot/issues/new?template=feature_request.md)
# **🙋‍♂️ FAQ**
<details>
<summary><strong>Why isn’t Vault search finding my notes?</strong></summary>
If you're using the Vault QA mode (or the tool <code>@vault</code> 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)](https://www.youtube.com/watch?v=mzMbiamzOqM)
- Ensure your Copilot indexing is up-to-date. Watch this video: [Vault Mode](https://www.youtube.com/watch?v=hBLMWE8WRFU)
- If issues persist, run <strong>Force Re-Index</strong> or use <strong>List Indexed Files</strong> from the Command Palette to inspect what's included in the index.
- ⚠️ <strong>Don’t switch embedding models after indexing</strong>—it can break the results.
</details>
<details>
<summary><strong>Why is my AI model returning error code 429: ‘Insufficient Quota’?</strong></summary>
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)](https://www.youtube.com/watch?v=mzMbiamzOqM)
- 🔍 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.
</details>
<details>
<summary><strong>Why am I getting a token limit error?</strong></summary>
Please refer to your model provider’s documentation for the context window size.
⚠️ If you set a large <strong>max token limit</strong> in your Copilot settings, you may encounter this error.
- <strong>Max tokens</strong> refers to <em>completion tokens</em>, 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 <strong>Vault QA</strong> mode in the dropdown (Copilot v2.1.0+ required).
</details>
Chat with your notes. QA your vault. Rewrite, summarize, and more. For more details, check out [documentation](https://www.obsidiancopilot.com/en/docs/).
## **🙏 Thank You**
@ -305,3 +144,5 @@ Copilot Plus is a premium product of Brevilabs LLC and it is not affiliated with
Brevilabs Team | Email: logan@brevilabs.com | X/Twitter: [@logancyang](https://twitter.com/logancyang)
[![MSeeP.ai Security Assessment Badge](https://mseep.net/pr/logancyang-obsidian-copilot-badge.png)](https://mseep.ai/app/logancyang-obsidian-copilot)