Skip to content

Obsidian canvas plugin for using AI completion with threads of canvas nodes

License

Notifications You must be signed in to change notification settings

NebulusIO/obsidian-chat-stream

 
 

Repository files navigation

Chat Stream 🔀

GitHub release (latest SemVer) Obsidian Downloads

An Obsidian plugin for conversing with GPT AI via canvas notes. Ancestor notes/files are included in the chat context. You can quickly create chat streams, and control what other notes are sent to the AI.

Install

Install as community plugin

Or, add rpggio/obsidian-chat-stream to BRAT.

Chat Stream is supported only on desktop.

Setup

Add an OpenAI API key in Chat Stream settings.

Usage

  1. Select a note in the canvas
  2. Press Alt+Shift+G to generate new note from GPT using current note + ancestors
  3. To create next note for responding, press Alt+Shift+N.

AI notes are colored purple, and tagged with chat_role=assistant in the canvas data file.

Development

  1. Download source and install dependencies
     pnpm install
    
  2. In Obsidian, install and enable hot reload plugin
  3. Create symbolic link from this project dir to an Obsidian store
     ln -s . your-obsidian-store/.obsidian/plugins/chat-stream
    
  4. Start dev server
    pnpm run dev
    
  5. In Obsidian, enable Chat Stream Plugin and add OpenAI key in plugin settings.

Changes to code should automatically be loaded into Obsidian.

Attribution

Say thanks

If you love it you can send me a coffee thumbs-up so I know folks find it useful.

About

Obsidian canvas plugin for using AI completion with threads of canvas nodes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.3%
  • JavaScript 5.0%
  • CSS 2.7%