Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AliDehbansiahkarbon/ChatGPTWizard
A ChatGPT, WriteSonic, YouChat, and Ollama(offline) plug-in for Embarcadero RAD Studio IDE 10.1 and later versions. https://getitnow.embarcadero.com/chatgptwizard
https://github.com/AliDehbansiahkarbon/ChatGPTWizard
chatgpt chatgpt-api delphi delphinuspackage embarcadero expert openai openai-api plugin radstudio
Last synced: about 1 month ago
JSON representation
A ChatGPT, WriteSonic, YouChat, and Ollama(offline) plug-in for Embarcadero RAD Studio IDE 10.1 and later versions. https://getitnow.embarcadero.com/chatgptwizard
- Host: GitHub
- URL: https://github.com/AliDehbansiahkarbon/ChatGPTWizard
- Owner: AliDehbansiahkarbon
- License: mit
- Created: 2023-01-12T08:05:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T07:49:51.000Z (8 months ago)
- Last Synced: 2024-05-01T19:12:34.452Z (7 months ago)
- Topics: chatgpt, chatgpt-api, delphi, delphinuspackage, embarcadero, expert, openai, openai-api, plugin, radstudio
- Language: Pascal
- Homepage: https://alidehbansiahkarbon.github.io/ChatGPTWizard/
- Size: 1.26 MB
- Stars: 226
- Watchers: 26
- Forks: 54
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-chatgpt - ChatGPTWizard - Embarcadero RAD Studio (Delphi & C++ Builder) plugin. (Integrations / Examples)
- awesome-chatgpt - ChatGPTWizard - Embarcadero RAD Studio (Delphi & C++ Builder) plugin. (Integrations / Examples)
README
# ChatGPTWizard
[](https://pepy.tech/project/video2tfrecord)
[](https://github.com/AliDehbansiahkarbon/ChatGPTWizard)
[](https://github.com/AliDehbansiahkarbon/ChatGPTWizard)
[](https://github.com/AliDehbansiahkarbon/ChatGPTWizard)
An AI plug-in for Embarcadero RAD Studio IDE.
First Plugin Ever to support Online(ChatGPT, Writesonic, and YouChat) and Offline(Ollama) AI servers!
Important Update
# Embarcadero introduced a built-in AI engine called Smart Codeinsight starting from version 12.2, so this plugin will not be updated for versions 12.2 and higher version but will be maintained for version 12.1 and earlier.
# Do not install this plugin on RAD Studio 12.2 or above IDE versions.
#### **PLEASE NOTE THAT You will need an API key (just in Online mode) to use this plugin. see the [API section](#platforms) to Generate an API key**
#### Some API Keys are Limited to a certain usage, after that, you will need to purchase credits to keep using them.
## Key Features:
- Free text question form.
- Dockable question form.
- Inline questions(in the editor).
- Context menu options to help you to find bugs, write tests, optimize code, add comments, etc...
- Class view(Code conversion, code optimizing, test units, and other options per class).
- Predefined Questions for class view.
- History to save your tokens on OpenAI!
- Fuzzy string match searches in the history.
- Animated letters(Like the website).
- AI Code Translator
- Proxy server options.
- Supports [OpenAI](https://openai.com) ChatGPT as the main AI service.
- Supports [Writesonic](https://writesonic.com/chat) AI as the second AI service.
- Supports [YouChat](https://you.com/code) AI as the third AI service.
- Supports [Ollama(Offline)](https://ollama.com)
# Supported IDE Versions
```delphi
Delphi 10.x (10.1 Berlin, 10.2 Tokyo, 10.3 Rio, 10.4 Sydney)
Delphi 11.x Alexandria
Delphi 12.x Athens
```
# Older IDE versions (XE2 to XE8)
If you are using Delphi XE2 to XE8, there is a limited version of this plug-in available, which has the main functionality.
Please have a look at that version [here](https://github.com/AliDehbansiahkarbon/ChatGPTWizard-XE2-to-XE8).
# Disclaimer
As a user of the API key, it is important to understand that you are solely responsible for all content generated through the prompt. Please note that there is no text moderation with this plugin, and your prompt will be sent directly to the AI Server through the API. While mistakes can happen while using browsers, mobile apps, or this plugin, it remains the responsibility of the user to ensure the accuracy and appropriateness of the content generated(prompts).
The plugin serves as a bridge between the user's IDE and the AI Server, enabling faster and smarter development. Please note that the plugin is intended for programming purposes only, and users should use it accordingly.
For more information, please refer to the Terms of Use defined by OpenAI: [Terms of use](https://openai.com/policies/terms-of-use#:~:text=What%20You%20Cannot,compete%20with%20OpenAI.)
# 🟢🟢🟢 How to use it in Offline mode 🟢🟢🟢
🟢 Set up an Offline AI server 👈👈👈
In order to use this plug-in with a local host follow these steps:
1- Download and Install Ollama : [here](https://ollama.com)
2- Check if the server is running by opening it in your browser: http://localhost:11434
You should see something like this screenshot:
3- Then you need at least one trained model to be attached to your new AI server, there are a lot of models [here](https://ollama.com/library), so choose one (codellama is a good one, I suggest that for now) and install it with this command in command-line:
```
ollama run codellama
```
After pulling the model is finished you can ask some questions in CMD right away.
4- Now use this URL instead of the OpenAPI's URL in the setting form of the Plugin in RAD Studio:
```
http://localhost:11434/api/generate
```
You don't need an Accesskey, no need to change or even clear it, just leave it.
5- Tick the checkbox called Ollama(Offline) and add your model name in the text box in front of the checkbox, in my case, I use "codellama" as the model name.
6- Congratulations! you did it, now enjoy forever free AI assistance.
Note: depending on the hardware resources, the model size, and the parameter count of the model you can experience different speeds and performance, **so do not open any issues about the Offline solution's speed or performance**, there is nothing to do about that with the Plug-in itself, Plug-in is just a bridge between AI server and RAD Studio.
Good luck!
## Demo videos
🟢 Short1(all features)
🟢 Short2(ChatGPT, Writesonic, and YouChat actions at the same time)
🟢 Long
## Platforms
This Plugin Supports the following AI Services:
### [ChatGPT](https://chat.openai.com/chat)
[generate API Key here](https://beta.openai.com/account/api-keys)
### [Writesonic](https://writesonic.com)
[generate API Key here](https://docs.writesonic.com/reference/finding-your-api-key)
### [YouChat](https://you.com/code)
[generate API Key here](https://api.you.com)
**NOTE: ChatGPT is working with Rad Studio 10.1 and above but Other(non-ChatGPT) AI Services are enabled in Rad Studio 10.2 and above!**
## Remarks
- This plugin is free but some AI Services are not free forever.
- It's compatible with Delphi 10.1 Berlin and later versions.
- Uses the XSuperObject library which is included in the project files. you can also find the latest version [here](https://github.com/onryldz/x-superobject/blob/master/XSuperObject.pas)
- Settings are stored in the registry which can be found here: `Computer\HKEY_CURRENT_USER\Software\ChatGPTWizard`
## How to Install
1- [Getit package manager](https://getitnow.embarcadero.com/chatgptwizard/)
2- [Delphinus package manager](https://github.com/Memnarch/Delphinus/wiki/Installing-Delphinus) - you can install Delphinus package manager and install ChatGPTWizard there. (Delphinus-Support)
3- Direct installation - Open the project in Delphi, right-click on the project node in the project manager, build, and install.
## How to Use
### **Plug-in's main form**
You can use the ChatGPT menu from the IDE's main menu directly to ask questions and get the answer.
Click on the newly added ChatGPT menu on the IDE(or press Ctrl+Shidt+Alt+C) to open the wizard, type the question, and press the Ask button(or Ctrl+Enter).
**Two New Tabs has been added to get separate results for Writesonic and YouChat.**
So now you can get multiple different answers based on any question, compare, merge, and get the best quality and accuracy for your code.
### **Settings**
**"Other AI Services"** Tab is responsible for setting up Other AI service's tokens including Writesonic's credentials.
## Inline Questions
If you need to use the ChatGPT inside the editor you need to type a question directly inside the code editor and surround it with `cpt:` at the beginning and `:cpt` at the end of the question then press `Ctrl+Shift+Alt+A` or simply select "Ask" from the editor's context menu by right-clicking on the selected text.
**Usage Scenario for Inline Questions**
Open a new `vcl` application project, add a new unit, and remove all the code from it! and type the following line,
select all and press `Ctrl+Shift+Alt+A`.
`cpt:Create a full unit in Delphi including a class to create an XML file.:cpt`
## Dockable Form
Use the **"ChatGPT Dockable"** menu from the main menu to show the dockable form and try to dock the form to the left or right side panel of the IDE, and enjoy with your new Google killer assistant!
## Context Menu
Context Menu for Selected text or a block of code. The Result will be inserted after the selected text as a multi-line comment between two brackets `{}`
**Options**
- Ask
- Add Test - Will try to create a unit test for the selected text.
- Find Bugs - Find fugs in the selected text.
- Optimize - Will Optimize the selected text.
- Add Comments - Will add necessary comments to the selected code.
- Complete code - Will try to add any missing code to the selected code.
- Explain code - will explain what the selected code does in Delphi.
## Class View
Using the class view you have your class list with some functionalities in a popup menu.
It is also possible to use your custom command based on the selected class in the TreeView, in this case, `@Class` will represent the selected class
in your custom command, if you don't use `@Class` the selected class' source will be attached to the end of your command, just pay attention there will be
some limitations because at the moment it's not possible to send thousands of lines through the API request.
Please note that it is best to use this feature for small classes. due to API limitations, you cannot send a class with several thousand lines of code in a question.
## History
History is available if you enable it in the setting form, it's using SQLite as a simple file-based database.
You can find an empty database in `Resource\DB` that named `"History.sdb"`, copy this file to any place in the disk and address it to the folder in the setting.
## Search in History
Right-click on the History grid and check the search item in the search bar that appears, it's not visible by default to save some space, finally, type the keyword
to search and filter, there are two checkboxes as extra options like case sensitive and fuzzy match string search.
## Issues with SSL
This issue can be fixed if you put SSL libraries(can find them in the resource folder) alongside the `bds.exe` or in the Bpl folder(mine is `C:\Users\Public\Documents\Embarcadero\Studio\22.0\Bpl`)
or you can use a build event on the project's properties to copy these two class libraries if they don't exist.
Another thing is, You don't have to do that because it will work fine when you open any project in the IDE before using this plugin! I'm not sure that this behavior depends on the installed components or libraries or if the IDE loads SSL libraries at the moment you open even a new application. although using the plugin when you are working on a project seems more useful anyways.
## Miscellaneous
**Presentation: [ChatGPT wizard.pptx](https://github.com/AliDehbansiahkarbon/ChatGPTWizard/files/10612086/CHAtGPT.wizard.pptx)**
## Contributors
**Special Thanks to**
- [Ali Sawari](https://github.com/AliSawari)
- [limelect](https://github.com/limelect)
Do not hesitate to star! if you like it take a leap of faith and hit that 'Star' button, also watch the repository to stay tuned with the latest updates, debugs, features, etc.
All PRs, discussions, and issues are welcome but please read and check the closed issues before opening a new one to avoid duplicates!
**Good luck!**
Made with :heart: on Delphi