Documentation

Welcome to Copilot for Obsidian documentation.

Copilot for Obsidian is an Obsidian plugin that allows you to chat with your vault using numerous LLMs. It is an open-source and privacy-focused AI assistant for your personal wiki. Beloved by many users both technical and non-technical, all features except Copilot Plus are free to use.

Copilot Plus is a paid version that unlocks multimodal AI agent experience. It is currently in closed alpha. If you'd like to join the alpha, please consider sponsoring the project on GitHub. I will prioritize sponsors for alpha access.

Features

Select a feature below to learn more about it.

Getting Started

Quickstart guide to get you up and running.

Copilot Settings

How to configure Copilot settings to get the most out of it.

Chat Mode

How to chat with various LLMs in Obsidian.

Copilot Commands

How to use Copilot commands in Obsidian command palette.

Custom Prompts

How to use the powerful custom prompts feature.

Vault QA (basic)

How to use the Vault QA feature with a combination of chat and embedding models.

Copilot Plus

Copilot Plus dashboard with license key management.

Troubleshooting

If you are experiencing any issues, please follow these steps to troubleshoot:

Check if you are on the latest version of Copilot.
Disable all other plugins to see if Copilot is causing the issue.
Turn on debug mode in Copilot settings.
Open the dev console in Obsidian by pressing cmd + option + i on Mac or ctrl + shift + i on Windows.
Try to understand the error message.
If you can't solve the problem and believe it's a bug, check GitHub to see if it's already reported. If not, please open an issue following the bug report template.