/Obsidian-AI

ChatGPT powered assistant for Obsidian "inspired by" Notion AI

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Obsidian AI

A shameless rip-off of Notion AI

I made this because I got jealous of Notion's AI feature.

YOU NEED TO USE YOUR OWN API KEY

FAQ

How does it work?

It uses ChatGPT

How do I use it?

  1. Create plugins folder in obsidian
  2. Create a folder called obsidian-ai in the .obsidian directory of your vault
  3. Add main.js, manifest.json, and styles.css to the recently created folder
    • Get the main.js, manifest.json and styles.css from the releases tab
    • Your route should look like: {your_vault}/.obsidian/plugins/obsidian-ai/{the three files here}
  4. Turn on community plugins
  5. If you don't see the plugin restart obsidian
  6. Turn on the plugin
  7. Go to the settings page of the plugin
  8. Type the API key in the field
  9. Restart your vault
  10. Open the command pallette (ctrl + p) and write "Obsidian AI" to see a list of the available commands

Will Notion come after you?

I don't think so. I'm not using their API. I'm using ChatGPT and paying for their API. I'm just using the same name as Notion's AI feature. That last line was created by GitHub Copilot. In all honestly I have no clue and rest assured I'll remove this if Notion comes after me.

Will OpenAI come after you?

Nope, I'm using (and paying for) their API.

I did X and it broke/didn't work

Yeah I didn't test this much. If you want it fixed open an issue or a PR.

Will it work on mobile?

It really should but I'm not sure. Let me know.

Plans for the future?

Add more commands, improve the UI and UX because it sucks for now.

Privacy concerns

You will be sending either the whole content of your current note or whatever you select to OpenAI chat API, be mindful of that

What is implemented? What is missing?

Implemented:

These are the ones that I got from https://github.com/sw-yx/ai-notes/blob/main/Resources/Notion%20AI%20Prompts.md and watching videos on Notion AI.

  • Help Me Write
  • Continue Writing (promptless)
  • Brainstorm Ideas
  • Summarize (promptless)
  • Find Action Items (promptless)
  • Blog Post
  • Pros and Cons List
  • Social Media Post
  • Outline
  • Creative Story
  • Poem
  • Essay
  • Meeting Agenda
  • Press Release
  • Job Description
  • Sales Email
  • Recruiting Email

Missing:

Either because I don't have the "original" prompt or because I don't know how they work/if there are already above. It probably won't work the same as Notions AI feature but I can mess around and find prompts that work

  • Improve writing
  • Fix spelling and grammar
  • Summarize
  • Translate
  • Explain this
  • Make longer
  • Make shorter
  • Find action items
  • Use simpler language
  • Help me edit
  • Help me write
  • Continue writing

Credits

TODO: Add credits correctly because I hate not giving proper credit to people