Chat with OpenAI models as a markdown file inside Obsidian desktop or mobile. Download the latest release here and add it to your .obsidian/plugins folder to get started.
- Edit the entire conversation, not just your next message, making few-shot prompting easy.
- Store and organize your chats in your Obsidian vault
- Configure your OpenAI API key and use either GPT-3.5-turbo or GPT-4.
Example: chat.md
What is 1 + 2?
✨📜: The answer is 3 ••◦
Conversation syntax
OpenAI Markdown prioritizes minimal syntax to ensure your files are as close to pure markdown as possible. Model responses are wrapped with Icons that can be set to any text string in the plugin settings. By default, a sequence of emojis are used (✨📜, ••◦). This means that all text not wrapped in the icons is considered a user message.
Send file to OpenAI
Run the command Send current file as conversation to OpenAI model to extract the conversation from the current file and send it to the configured OpenAI model to get a response. Consider binding this to a hotkey like cmd+enter.
Note: Model responses are streamed to the file which can cause issues with scrolling while the model is responding
Reruns
By default, if you send a file to OpenAI without adding a new message it will delete the previous model response and regenerate it.
Delete last model response
Run the command Delete last response from model Consider binding this to a hotkey like cmd+backspace.
This is an early release and likely has bugs. Please be careful and consider the risks before uses:
- Your OpenAI API key will be stored in your Obsidian vault. This may expose your API key to other plugins. Consider generating a specific API key to ensure you can easily rotate.
- Conversation syntax is very basic and if the
Iconsequence appears in the model's output or in a user message it will break the parser. - API requests have minimal error handling. This may result in hanging requests or UI lag.
- OpenAI models are normally very good about outputting valid markdown, but there is little to no output sanitation.
Download the latest release here and add it to your .obsidian/plugins folder.
Build it yourself
Clone this repo inside your <Your Obsidian Vault Location>/.obsidian/plugins folder. Run npm i or yarn and then npm run build or yarn build. You will see a file called main.js in the root directory if it worked.
As the plugin stabilizes it will be published as a community plugin.
Find me @benemills on twitter and @benmills on Farcaster.