diff --git a/README.md b/README.md index d1311377..534f176d 100644 --- a/README.md +++ b/README.md @@ -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. +

+ Product UI screenshot +

+ +**Chat Mode** + +

+ +

+ +**Vault QA** + +

+ +

+ +**Agentic Mode** + +

+ +

Copilot's Agent can call the proper tools on its own upon your request.

-

- Product UI screenshot -

+ ## 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.

- - AI Model API Key -
- Click the image to watch the video on YouTube +

-**📖** **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}."_ - -

- - Chat Mode -
- Click the image to watch the video on YouTube -

- -**📖** **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. - -

- - Vault Mode -
- Click the image to watch the video on YouTube -

- -**📖 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. - -

- - One-Click Commands -
- Click the image to watch the video on YouTube -

- -**📖 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 / ! - -

- - Prompt Palette -
- Click the image to watch the video on YouTube -

- -**📖 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. - -

- - Relevant Notes -
- Click the image to watch the video on YouTube -

- -### 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. - -

- - Copilot Plus Setup -
- Click the image to watch the video on YouTube -

- -❔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. - -

- Discord support screenshot -

- -**📖 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. - -

- - Time-Based Queries -
- Click the image to watch the video on YouTube -

- -**📖 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._ - -

- - One Prompt, Every Source -
- Click the image to watch the video on YouTube -

- -# **💡 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** - -
- 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)](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 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)](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. - -
- -
- 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). - -
+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) + +