diff --git a/README.md b/README.md index ef21e789..67e1f650 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,12 @@ The Ultimate AI Assistant for Your Second Brain

-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 Copilot's Agent can call the proper tools on its own upon your request.

- Product UI screenshot + Product UI screenshot

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

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

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

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

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

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

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

- - One-Click Commands -
- Click the image to watch the video on YouTube + Add Selection to Context

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

- - Prompt Palette -
- Click the image to watch the video on YouTube + Quick Command

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

- - Relevant Notes -
- Click the image to watch the video on YouTube + One-Click Commands

-### Level Up with Copilot Plus and Beyond +**Create your Command** + +Create commands and workflows in `Settings → Copilot → Command → Add Cmd`. + +

+ Create Command +

+ +**Command Palette in Chat** + +Type `/` to use Command Palette in chat window. + +

+ Prompt Palette +

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

+ Relevant Notes +

+ +### 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?*

- - Copilot Plus Setup -
- Click the image to watch the video on YouTube + Time-Based Queries

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

- Discord support screenshot + Agent Mode

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

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

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

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

-# **💡 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**
Why isn’t Vault search finding my notes? @@ -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) - diff --git a/images/Add-Context.png b/images/Add-Context.png new file mode 100644 index 00000000..1a3de987 Binary files /dev/null and b/images/Add-Context.png differ diff --git a/images/Add-Selection-to-Context.png b/images/Add-Selection-to-Context.png new file mode 100644 index 00000000..fce92cbf Binary files /dev/null and b/images/Add-Selection-to-Context.png differ diff --git a/images/Agent-Mode.png b/images/Agent-Mode.png new file mode 100644 index 00000000..4ba654cd Binary files /dev/null and b/images/Agent-Mode.png differ diff --git a/images/Chat-Mode.png b/images/Chat-Mode.png index f111e88d..452c0d5c 100644 Binary files a/images/Chat-Mode.png and b/images/Chat-Mode.png differ diff --git a/images/Create-Command.png b/images/Create-Command.png new file mode 100644 index 00000000..ee2ff7b3 Binary files /dev/null and b/images/Create-Command.png differ diff --git a/images/Note-Image.png b/images/Note-Image.png new file mode 100644 index 00000000..902c6f63 Binary files /dev/null and b/images/Note-Image.png differ diff --git a/images/One-Click-Commands.png b/images/One-Click-Commands.png index a1ce6217..39f2993b 100644 Binary files a/images/One-Click-Commands.png and b/images/One-Click-Commands.png differ diff --git a/images/One-Prompt-Every-Source.png b/images/One-Prompt-Every-Source.png index daeb2616..f68a5a13 100644 Binary files a/images/One-Prompt-Every-Source.png and b/images/One-Prompt-Every-Source.png differ diff --git a/images/Prompt-Palette.png b/images/Prompt-Palette.png index 7dcb2374..e007cdb1 100644 Binary files a/images/Prompt-Palette.png and b/images/Prompt-Palette.png differ diff --git a/images/Quick-Command.png b/images/Quick-Command.png new file mode 100644 index 00000000..9ca73bd4 Binary files /dev/null and b/images/Quick-Command.png differ diff --git a/images/Relevant-Notes.png b/images/Relevant-Notes.png index 610335d2..67625604 100644 Binary files a/images/Relevant-Notes.png and b/images/Relevant-Notes.png differ diff --git a/images/Time-Based-Queries.png b/images/Time-Based-Queries.png index f24ed883..e362810c 100644 Binary files a/images/Time-Based-Queries.png and b/images/Time-Based-Queries.png differ diff --git a/images/Vault-Mode.png b/images/Vault-Mode.png index f8697a30..ab48b416 100644 Binary files a/images/Vault-Mode.png and b/images/Vault-Mode.png differ diff --git a/images/chat mode image.png b/images/chat mode image.png new file mode 100644 index 00000000..08d82200 Binary files /dev/null and b/images/chat mode image.png differ diff --git a/images/product-ui-screenshot.jpeg b/images/product-ui-screenshot.jpeg deleted file mode 100644 index 5cfa0e8b..00000000 Binary files a/images/product-ui-screenshot.jpeg and /dev/null differ diff --git a/images/product-ui-screenshot.png b/images/product-ui-screenshot.png new file mode 100644 index 00000000..7e975076 Binary files /dev/null and b/images/product-ui-screenshot.png differ