No description
Find a file
2023-05-12 22:18:06 -07:00
images Update name to Copilot for Obsidian 2023-05-10 13:56:38 -07:00
src Add better error messages for OpenAI API errors 2023-05-10 16:14:05 -07:00
typings Add correct implementation of sse and stopStreaming 2023-04-21 20:40:53 -07:00
.editorconfig Initial commit 2023-03-30 17:15:32 -07:00
.eslintignore Initial commit 2023-03-30 17:15:32 -07:00
.eslintrc Initial commit 2023-03-30 17:15:32 -07:00
.gitignore Initial commit 2023-03-30 17:15:32 -07:00
.npmrc Initial commit 2023-03-30 17:15:32 -07:00
esbuild.config.mjs Add correct implementation of sse and stopStreaming 2023-04-21 20:40:53 -07:00
jest.config.js Add tests for chat context 2023-04-08 22:57:45 -07:00
LICENSE Add license 2023-03-30 23:52:55 -07:00
manifest.json 1.2.2 2023-05-12 13:17:34 -07:00
package-lock.json 1.2.2 2023-05-12 13:17:34 -07:00
package.json 1.2.2 2023-05-12 13:17:34 -07:00
README.md Add section for community plugin installation 2023-05-10 14:07:30 -07:00
styles.css Make text input area scrollable 2023-05-12 22:18:06 -07:00
tsconfig.json Remove fetch and use SSE instead 2023-04-20 20:30:14 -07:00
version-bump.mjs Initial commit 2023-03-30 17:15:32 -07:00
versions.json 1.2.2 2023-05-12 13:17:34 -07:00

🔍 Copilot for Obsidian

Copilot for Obsidian is a ChatGPT interface right inside Obsidian. It has a minimalistic design and is straightforward to use.

  • 💬 ChatGPT integration in Obsidian.
  • 🚀 Turbocharge your Second Brain with AI.
  • 🧠 Talk to your past notes for insights.
  • 🛠️ Prompt AI with your writing to get quick results.

Buy Me A Coffee

🛠️ Features

  • Chat with ChatGPT right inside Obsidian in the Copilot Chat window.
  • No repetitive login. Use your own API key (stored locally).
  • No monthly fee. Pay only for what you use.
  • Model selection of GPT-3.5 and GPT-4.
  • No need to buy ChatGPT Plus to use GPT-4 if you have API access.
  • No usage cap for GPT-4 like ChatGPT Plus.
  • One-click copying any message as markdown.
  • One-click saving the entire conversation as a note.
  • One-click using the active note as context, and start a discussion around it (currently only supports shorter notes)
  • Easy commands to simplify, emojify, translate, rewrite into a tweet/thread, and more.
  • Set your own parameters like LLM temperature, max tokens, conversation context based on your need (pls be mindful of the API cost).

🎬 Demo

Video Thumbnail

  • Chat with ChatGPT, copy messages to note, save entire conversation as a note
  • QA around your past note
  • Fix grammar and spelling, Summarize, Simplify, Emojify, Remove URLs
  • Generate glossary, table of contents
  • Translate to a language of your choosing
  • Change tone: professional, casual, straightforward, confident, friendly
  • Make longer/shorter
  • Rewrite into a tweet/thread

The settings page lets you set your own temperature, max tokens, conversation context based on your need:

Settings

⚙️ Installation

Copilot for Obsidian is now available in Obsidian Community Plugin!

  • Open Community Plugins settings page, click on the Browse button.
  • Search for "Copilot" in the search bar and find the plugin with this exact name.
  • Click on the Install button.
  • Once the installation is complete, enable the Copilot plugin by toggling on its switch in the Community Plugins settings page.

Now you can see the chat icon in your leftside ribbon, clicking on it will open the chat panel on the right! Don't forget to check out the Copilot commands available in the commands palette!

🔧 Manual Installation

  • Go to the latest release
  • Download main.js, manifest.json, styles.css and put them under .obsidian/plugins/obsidian-copilot/ in your vault
  • Open your Obsidian settings > Community plugins, and turn on Copilot.

📝 Planned features (based on feedback)

  • More standard prompts that can be used with commands
  • User custom prompts
  • Online prompt library access
  • Unlimited context, i.e. very long notes, a collection of notes or the entire vault
  • Integration with ChatGPT plugins

🔔 Note

  • The chat history is not saved by default. Please use "Save as Note" to save it. The note will have a title Chat-Year_Month_Day-Hour_Minute_Second, you can change its name as needed.
  • "New Chat" clears all previous chat history. Again, please use "Save as Note" if you would like to save the chat.
  • "Use Active Note as Context" does not support super long notes yet since the OpenAI API has a limited context length (currently about 4K, 8K, or 32K tokens depending on the model you use). In the future I'm considering supporting very long notes / a folder of notes / the entire vault as context if there is enough demand.
  • You can set a very long context in the setting "Conversation turns in context" if needed.

📣 Again, please always be mindful of the API cost if you use GPT-4 with a long context!