readme revamp: 1. added table of content 2. replace youtube videos wi… (#1915)
* readme revamp: 1. added table of content 2. replace youtube videos with updated screenshots. * added create command, quick command and add selection to context section * replace screenshots with bigger texts; add table of contents for usage section * change screenshot resolution to correct distortion; modify a prompt to match the prompt in screenshot
224
README.md
|
|
@ -22,7 +22,12 @@ The Ultimate AI Assistant for Your Second Brain
|
|||
</a>
|
||||
</p>
|
||||
|
||||
Copilot for Obsidian is your ultimate in‑vault AI assistant with chat-based vault search, web and youtube support, powerful context processing and ever-expanding agentic capabilities—all within Obsidian’s highly customizable workspace.
|
||||
|
||||
## Overview
|
||||
|
||||
Copilot for Obsidian is your ultimate in‑vault AI assistant with chat-based vault search, web and youtube support, powerful context processing and ever-expanding agentic capabilities—all within Obsidian's highly customizable workspace.
|
||||
|
||||
## 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.
|
||||
|
|
@ -36,9 +41,20 @@ Copilot for Obsidian is your ultimate in‑vault AI assistant with chat-based va
|
|||
<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"/>
|
||||
<img src="./images/product-ui-screenshot.png" alt="Product UI screenshot" width="800"/>
|
||||
</p>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Get Started](#get-started)
|
||||
- [Install Obsidian Copilot](#install-obsidian-copilot)
|
||||
- [Set API Keys](#set-api-keys)
|
||||
- [Usage](#usage)
|
||||
- [Free User](#free-user)
|
||||
- [Copilot Plus/Believer](#copilot-plusbeliever)
|
||||
- [Need Help?](#need-help)
|
||||
- [FAQ](#️faq)
|
||||
|
||||
## 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!
|
||||
|
|
@ -55,164 +71,177 @@ 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.
|
||||
|
||||
## Usage
|
||||
|
||||
### Table of Contents
|
||||
- [Free User](#free-user)
|
||||
- [Chat Mode](#chat-mode-reference-notes-and-discuss-ideas-with-copilot)
|
||||
- [Vault QA Mode](#vault-qa-mode-chat-with-your-entire-vault)
|
||||
- [Command Palette](#copilots-command-palette)
|
||||
- [Relevant Notes](#relevant-notes-notes-suggestions-based-on-semantic-similarity-and-links)
|
||||
- [Copilot Plus/Believer](#copilot-plusbeliever)
|
||||
- [Time-Based Queries](#get-precision-insights-from-a-specific-time-window)
|
||||
- [Agent Mode](#agent-mode-autonomous-tool-calling)
|
||||
- [Image Understanding](#understand-images-in-your-notes)
|
||||
- [Multi-Source Analysis](#one-prompt-every-sourceinstant-summaries-from-pdfs-videos-and-web)
|
||||
|
||||
### Free User
|
||||
|
||||
#### **Chat Mode: reference notes and discuss ideas with Copilot**
|
||||
|
||||
Use `@` to add context and chat with your note.
|
||||
|
||||
<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>
|
||||
<img src="./images/Add-Context.png" alt="Chat Mode" width="700">
|
||||
</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.
|
||||
|
||||
- 💭 **In `Chat` mode, ask Copilot:**
|
||||
> _"Summarize [[Meeting Notes – March]] and create a follow-up task list based on notes in {projects}."_
|
||||
Ask Copilot:
|
||||
> *Summarize [[Q3 Retrospective]] and identify the top 3 action items for Q4 based on the notes in {01-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>
|
||||
<img src="./images/Chat-Mode.png" alt="Chat Mode" width="700">
|
||||
</p>
|
||||
|
||||
**📖** **Vault QA Mode: Chat With Your Entire Vault**
|
||||
#### **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.
|
||||
Ask Copilot:
|
||||
> *What are the recurring themes in my research regarding the intersection of AI and SaaS?*
|
||||
|
||||
- 💭 **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>
|
||||
<img src="./images/Vault-Mode.png" alt="Vault Mode" width="700">
|
||||
</p>
|
||||
|
||||
**📖 Edit and Apply with One Click**
|
||||
#### 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.
|
||||
|
||||
- 🧠 **Use When:** You want to quickly fix grammar, spelling or wording directly in your notes—without switching tabs or manually rewriting.
|
||||
**Add selection to chat context**
|
||||
|
||||
- 💭 **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.
|
||||
Select text and add it to context. Recommend shortcut: `ctrl/cmd + L`
|
||||
|
||||
<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>
|
||||
<img src="./images/Add-Selection-to-Context.png" alt="Add Selection to Context" width="700">
|
||||
</p>
|
||||
|
||||
**📖 Automate your workflow with the Copilot Prompt Palette**
|
||||
**Quick Command**
|
||||
|
||||
- 🧠 **Use When:** You want to speed up repetitive tasks like summarizing, rewriting, or translating without typing full prompts every time.
|
||||
Select text and apply action without opening chat. Recommend shortcut: `ctrl/cmd + K`
|
||||
|
||||
- 💭 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>
|
||||
<img src="./images/Quick-Command.png" alt="Quick Command" width="700">
|
||||
</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.
|
||||
**Edit and Apply with One Click**
|
||||
|
||||
- 💭 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.
|
||||
Select text and edit with one RIGHT click.
|
||||
|
||||
<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>
|
||||
<img src="./images/One-Click-Commands.png" alt="One-Click Commands" width="700">
|
||||
</p>
|
||||
|
||||
### Level Up with Copilot Plus and Beyond
|
||||
**Create your Command**
|
||||
|
||||
Create commands and workflows in `Settings → Copilot → Command → Add Cmd`.
|
||||
|
||||
<p align="center">
|
||||
<img src="./images/Create-Command.png" alt="Create Command" width="700">
|
||||
</p>
|
||||
|
||||
**Command Palette in Chat**
|
||||
|
||||
Type `/` to use Command Palette in chat window.
|
||||
|
||||
<p align="center">
|
||||
<img src="./images/Prompt-Palette.png" alt="Prompt Palette" width="700">
|
||||
</p>
|
||||
|
||||
#### **Relevant Notes: notes suggestions based on semantic similarity and links**
|
||||
|
||||
Appears automatically when there's useful related content and links.
|
||||
|
||||
Use it to quickly reference past research, ideas, or decisions—no need to search or switch tabs.
|
||||
|
||||
<p align="center">
|
||||
<img src="./images/Relevant-Notes.png" alt="Relevant Notes" width="700">
|
||||
</p>
|
||||
|
||||
### 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.
|
||||
|
||||
🆙 **Upgrade to Copilot Plus**
|
||||
#### **Get Precision Insights From a Specific Time Window**
|
||||
|
||||
First, go to https://www.obsidiancopilot.com/en to subscribe to Copilot Plus. Then, set up Copilot Plus License Key in Obsidian.
|
||||
In agent mode, ask copilot:
|
||||
|
||||
> *What did I do last week?*
|
||||
|
||||
<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>
|
||||
<img src="./images/Time-Based-Queries.png" alt="Time-Based Queries" width="700">
|
||||
</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.
|
||||
#### **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.*
|
||||
|
||||
<p align="center">
|
||||
<img src="./images/discord-support.png" alt="Discord support screenshot" width="700"/>
|
||||
<img src="./images/Agent-Mode.png" alt="Agent Mode" width="700">
|
||||
</p>
|
||||
|
||||
**📖 Get Precision Insights From a Specific Time Window**
|
||||
#### **Understand Images in Your Notes**
|
||||
|
||||
- 🧠 **Use When:** You want to quickly review tasks, notes, or ideas from a specific time range without manually digging through files.
|
||||
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.
|
||||
|
||||
- 💭 **In Chat mode, ask Copilot:**
|
||||
Ask Copilot to analyze your wireframes:
|
||||
|
||||
> _"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.
|
||||
> *Analyze the wireframe in [[UX Design - Mobile App Wireframes]] and suggest improvements for the navigation flow.*
|
||||
|
||||
<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>
|
||||
<img src="./images/Note-Image.png" alt="Image Understanding" width="700">
|
||||
</p>
|
||||
|
||||
**📖 One Prompt, Every Source—Instant Summaries from PDFs, Videos, and Web**
|
||||
#### **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:**
|
||||
In agent mode, ask Copilot
|
||||
|
||||
> "Please write a short intro of Kiwi birds based on the following information I collected about this animal.
|
||||
> *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*
|
||||
|
||||
> 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>
|
||||
<img src="./images/One-Prompt-Every-Source.png" alt="One Prompt, Every Source" width="700">
|
||||
</p>
|
||||
|
||||
# **💡 Need Help?**
|
||||
## **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.
|
||||
|
|
@ -231,7 +260,7 @@ First, go to https://www.obsidiancopilot.com/en to subscribe to Copilot Plus. Th
|
|||
- ☑️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**
|
||||
## **FAQ**
|
||||
|
||||
<details>
|
||||
<summary><strong>Why isn’t Vault search finding my notes?</strong></summary>
|
||||
|
|
@ -303,4 +332,3 @@ Copilot Plus is a premium product of Brevilabs LLC and it is not affiliated with
|
|||
## **Authors**
|
||||
|
||||
Brevilabs Team | Email: logan@brevilabs.com | X/Twitter: [@logancyang](https://twitter.com/logancyang)
|
||||
|
||||
|
|
|
|||
BIN
images/Add-Context.png
Normal file
|
After Width: | Height: | Size: 1.7 MiB |
BIN
images/Add-Selection-to-Context.png
Normal file
|
After Width: | Height: | Size: 2.2 MiB |
BIN
images/Agent-Mode.png
Normal file
|
After Width: | Height: | Size: 1.8 MiB |
|
Before Width: | Height: | Size: 723 KiB After Width: | Height: | Size: 2.4 MiB |
BIN
images/Create-Command.png
Normal file
|
After Width: | Height: | Size: 898 KiB |
BIN
images/Note-Image.png
Normal file
|
After Width: | Height: | Size: 2.8 MiB |
|
Before Width: | Height: | Size: 430 KiB After Width: | Height: | Size: 1.2 MiB |
|
Before Width: | Height: | Size: 1.1 MiB After Width: | Height: | Size: 2 MiB |
|
Before Width: | Height: | Size: 532 KiB After Width: | Height: | Size: 1.8 MiB |
BIN
images/Quick-Command.png
Normal file
|
After Width: | Height: | Size: 1.2 MiB |
|
Before Width: | Height: | Size: 626 KiB After Width: | Height: | Size: 2.3 MiB |
|
Before Width: | Height: | Size: 595 KiB After Width: | Height: | Size: 1.9 MiB |
|
Before Width: | Height: | Size: 243 KiB After Width: | Height: | Size: 2 MiB |
BIN
images/chat mode image.png
Normal file
|
After Width: | Height: | Size: 1.3 MiB |
|
Before Width: | Height: | Size: 713 KiB |
BIN
images/product-ui-screenshot.png
Normal file
|
After Width: | Height: | Size: 3 MiB |