Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arumie/obsidian-simple-prompt-plugin
Simple Prompt Plugin is a plugin for Obsidian that allows you generate content in your notes using LLMs.
https://github.com/arumie/obsidian-simple-prompt-plugin
ai llm node obsidian obsidian-md obsidian-plugin openai plugin
Last synced: 3 months ago
JSON representation
Simple Prompt Plugin is a plugin for Obsidian that allows you generate content in your notes using LLMs.
- Host: GitHub
- URL: https://github.com/arumie/obsidian-simple-prompt-plugin
- Owner: arumie
- License: mit
- Created: 2024-05-26T14:26:03.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-16T07:44:32.000Z (7 months ago)
- Last Synced: 2024-09-30T09:40:51.372Z (3 months ago)
- Topics: ai, llm, node, obsidian, obsidian-md, obsidian-plugin, openai, plugin
- Language: TypeScript
- Homepage:
- Size: 13.9 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-obsidian-ai-tools - https://github.com/arumie/obsidian-simple-prompt-plugin
- awesome-obsidian-ai-tools - https://github.com/arumie/obsidian-simple-prompt-plugin
README
# Simple Prompt
## What is Simple Prompt?
Simple Prompt allows you generate content in your notes using Large Language Models.
It provides a simple interface to generate content, rewrite selection or whole notes based on a prompt you provide.
## Commands and Options
It provides the following commands:
- **Generate content at your cursor**: This command will generate content at the cursor position.
- **Rewrite selection**: This command will replace the selected text with the generated content.
- **Rewrite document**: This command will replace the entire document with the generated content.
- **Generate from YouTube**: This command will generate content based on a YouTube video URL and a request at the cursor position.
- **OBS**, this command uses the captions of the video to generate content, so if the video is not transcribed or doesn't have sound, it will not work.
It also gives the following options:
- **Pick which LLM to use**: Choose from a list of LLMs and Providers to generate content.
- Supports OpenAI and Ollama
- **Customize Prompt Templates**: You can customize the prompt templates to generate content based on your needs.
- **Recent prompts**: You can view the recent prompts you have used and reuse them.
- **Streaming responses**: You can toggle streaming responses for the generation commands.
## Future Features
- Add support for other LLMs (Anthropic Claude, Cohere Aya, Llama-files etc.)
- Add "**Generate image**" command to generate images using LLMs.
- Add support for **indexing all documents in the vault** and generating content based on the index.
- Add encryption for the saved API key.
- Add support for adding custom actions and templates
## How to use
- Clone this repo into your Obsidian vault's plugins folder.
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.
- `npm run build:css` to build the css.
### Manually installing the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/simple-prompt-plugin/`.
- Reload Obsidian.
**Note**: The plugin saves the API key in the Obsidian vault settings. Make sure to keep your API key safe.
- If using Git plugin. Add .gitignore with `.obsidian/plugins/simple-prompt-plugin/data.json` to the vault to avoid pushing the API key to your repository.
## Demo
### YouTube Link Demo
## Changes
Changelog is available [here](https://github.com/arumie/obsidian-simple-prompt-plugin/blob/main/CHANGELOG.md)