Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin

๐Ÿ’ฌ Experience OpenAI ChatGPT assistance directly within Obsidian, drafting content without interrupting your creative flow.
https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin

chatgpt-api gpt obsidian obsidian-md obsidian-plugin typescript

Last synced: about 1 month ago
JSON representation

๐Ÿ’ฌ Experience OpenAI ChatGPT assistance directly within Obsidian, drafting content without interrupting your creative flow.

Awesome Lists containing this project

README 

        
# GPT-LiteInquirer Plugin for Obsidian






[![CI][ci-image]][ci-url]

[![Code Scanning][code-scanning-image]][code-scanning-url]

[![TAG][tag-image]][tag-url]



[![Downloads][downloads-image]][downloads-url]



[ci-image]: https://img.shields.io/github/actions/workflow/status/ittuann/obsidian-gpt-liteinquirer-plugin/CI.yml?branch=master&label=Build%20Status&logo=github&style=for-the-badge

[ci-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin

[code-scanning-image]: https://img.shields.io/github/actions/workflow/status/ittuann/obsidian-gpt-liteinquirer-plugin/CodeQL.yml?branch=master&label=Code%20Scanning&logo=github&style=for-the-badge

[code-scanning-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin

[tag-image]: https://img.shields.io/github/v/release/ittuann/obsidian-gpt-liteinquirer-plugin?branch=master&label=Release%20tag&logo=github&style=for-the-badge

[tag-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/releases/latest

[downloads-image]: https://img.shields.io/github/downloads/ittuann/obsidian-gpt-liteinquirer-plugin/total?logo=github&style=for-the-badge

[downloads-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/releases/latest








Language:

:gb: English ยท 

:cn: ็ฎ€ไฝ“ไธญๆ–‡




With this GPT-LiteInquirer Plugin, you can quickly and senselessly generate ideas, draft content, or get assistance from the ChatGPT AI, all without leaving Obsidian, without interrupt your creative flow.



The Lightweight ChatGPT Plugin is a fast, easy-to-use, and non-intrusive AI assistant plugin, which senselessly integrates OpenAI's ChatGPT API directly into Obsidian.



If you enjoy this plugin or would like to show your support, please consider giving it a free [Star โœจ](https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin) on GitHub~



> [!NOTE]

> **Install and view this plugin automatically within Obsidian: [Click here](https://obsidian.md/plugins?id=gpt-liteinquirer)**



**Download manually: [Click here](https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/releases/latest)**. You only need to manually download `main.js`, `styles.css` and `manifest.json` and put them in the `.obsidian\plugins\gpt-liteinquirer` folder.



## โœจ Features



-   **Seamless integration with Obsidian:**



    -   Enjoy the convenience of accessing lightweight ChatGPT directly within Obsidian.

    -   You no longer have to worry about being interrupted in your creative process by leaving Obsidian to switch between software.



-   **User-friendly interface:**



    -   Interact with the ChatGPT API through an intuitive and straightforward lightweight design interface.



-   **Diverse ways to use:**



    -   You can quickly input the current document as a knowledge base into ChatGPT, and ask any questions about any content.

    -   You can also directly start a conversation with ChatGPT, quickly drafting and enriching your content, generating new ideas, or using the ChatGPT artificial intelligence to do anything you want.



-   **Flexible response handling:**

    -   Copy the AI-generated response to the clipboard. Alternatively, insert it directly at the cursor position in your current document, or at the end of the document.



## ๐Ÿงฉ Configuration



> [!IMPORTANT]

> You must need to set your own OpenAI API key in the Plugin Settings first, so that the plugin can work properly.



1. Generate an OpenAI API key on the official website. [Click here](https://beta.openai.com/account/api-keys)

2. In Obsidian, go to `Settings`, click `Community Plugins` in the left menu , and enable `GPT-LiteInquirer` in the Installed Plugins.

3. Click the gear icon to enter the plugin settings. Then enter your API key in the `OpenAI API Key` field and then you're done! ๐ŸŽ‰



To download Obsidian: [Click here](https://www.obsidian.md/)



## ๐Ÿ“ Usage



You can open the Lightweight ChatGPT Plugin interface in three ways:



-   By clicking on the Obsidian ribbon on the left.

-   By the Obsidian command `Open Lightweight Window`.

-   By manually set a keyboard shortcut for the command, such as `CTRL + K`.



When opening the GPT Lite Inquirer window, the content you selected in the current Markdown document will be copied to the text box automatically. So you can use this text to ask questions or perform other operations, or directly write down anything you want to say.



Tips: You can also send content directly using the `CTRL + ENTER` shortcut.



---



TODO List:



-   [x] Add configuration default Prompt

-   [x] Add support for self-built API

-   [ ] Add support for GPT-4

-   [ ] Add support for Azure API



GPT-LiteInquirer Plugin for Obsidian wants to be a nice companion to boost your creativity and productivity. Experience the seamless AI-enhanced writing and content generation capabilities within Obsidian today!



## License



The project is [MIT Licensed](https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/blob/master/LICENSE).



[![FOSSA License Compliance Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin?ref=badge_large&issueType=license)