obsidian-plugin/logancyang_obsidian-copilot
1
0
Fork 0
mirror of https://github.com/logancyang/obsidian-copilot.git synced 2026-07-22 07:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
73 commits 55 branches 115 tags 260 MiB
TypeScript 98.7%
JavaScript 0.7%
CSS 0.5%
Find a file
Logan Yang 07b4433d06 Update readme with features
2023-04-12 15:30:39 -07:00
src Update Use Note as Context behavior 2023-04-12 13:16:30 -07:00
tests Add openai settings 2023-04-12 12:30:44 -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 user and bot icons and styling 2023-04-04 13:09:45 -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 Add github sponsor link 2023-04-02 22:15:19 -07:00
package-lock.json Add tests for chat context 2023-04-08 22:57:45 -07:00
package.json Update plugin name in package.json 2023-04-08 23:30:35 -07:00
README.md Update readme with features 2023-04-12 15:30:39 -07:00
styles.css Fix unclickable copy button under content 2023-04-11 12:09:14 -07:00
tsconfig.json Add path alias and update imports 2023-04-05 09:06:42 -07:00
version-bump.mjs Initial commit 2023-03-30 17:15:32 -07:00
versions.json Initial commit 2023-03-30 17:15:32 -07:00

README.md

Obsidian Copilot

  • ChatGPT integration in Obsidian.
  • Turbocharge your Second Brain with AI.
  • Talk to your past notes for insights. Take your note-taking game to the next level with the Obsidian Copilot Plugin!

Features

  • Chat with ChatGPT right in Obsidian in the Copilot Chat window.
  • No repetitive login. Use your own API key.
  • 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 right inside Obsidian
  • One-click using the active note as context, and start a discussion around it (currently only supports shorter notes)
  • Set your own parameters like LLM temperature, max tokens, conversation context based on your need (pls be mindful of the API cost).

Planned features (based on feedback)

  • More standard prompts that can be used with commands
  • User customized prompts
  • Online prompt library access
  • Integration with ChatGPT plugins when I get access

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!

Demo

(add gifs)

Changelog

  • v1.0.1: Initial release