Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/overflowy/chat-key
Supercharge your productivity with ChatGPT and AutoHotkey 🚀
https://github.com/overflowy/chat-key
ahk ai application autohotkey chatgpt completion gpt-4 productivity prompt tool windows
Last synced: 3 months ago
JSON representation
Supercharge your productivity with ChatGPT and AutoHotkey 🚀
- Host: GitHub
- URL: https://github.com/overflowy/chat-key
- Owner: overflowy
- License: mit
- Created: 2023-07-06T15:14:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-18T07:33:46.000Z (about 1 year ago)
- Last Synced: 2024-06-15T07:33:23.140Z (5 months ago)
- Topics: ahk, ai, application, autohotkey, chatgpt, completion, gpt-4, productivity, prompt, tool, windows
- Language: AutoHotkey
- Homepage:
- Size: 1.03 MB
- Stars: 89
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ChatGPT-repositories - chat-key - Supercharge your productivity with ChatGPT and AutoHotkey 🚀 (Prompts)
README
## About
ChatKey is small tool that enables you to use your own ChatGPT/GPT-4 prompts in any application that supports text input.
## Usage
1. Please ensure that you have configured the OPENAI_TOKEN environment variable with your API key
2. Download the [latest release](https://github.com/overflowy/chat-key/releases/latest)
3. Extract all files from the zip
4. Run `ChatKey.exe`
5. Start typing in any application that supports text input
6. Select the text to use as input for the prompt
7. Press the hotkey to show the popup menu (default: `Alt + .`).
8. Select the prompt from the popup menu
9. Wait for the response to be generated
10. Review the generated response and press `Enter`
[I versus AI](https://www.youtube.com/@IversusAI) has done an incredible video covering most topics:
[](https://www.youtube.com/watch?v=4mraUhvVrOc&t=628s)
## Configuration
To configure ChatKey, you can edit the [`config.ini`](config.ini) file provided.
### General settings
| Key | Description | Default |
| ------------------- | --------------------------------------------------------- | --------- |
| `popup_menu_hotkey` | The hotkey to show the popup menu | `Alt + .` |
| `replace_text` | Whether to replace the selected text with the response | `0` |
| `show_notification` | Whether to show a notification when generating a response | `1` |
| `max_input_length` | The maximum length of input text (0 = unlimited) | `0` |
### Adding prompts
To add new prompts, you must include a new section in the [`config.ini`](config.ini) file. For instance, if you wish to include a prompt for translating text to French, you can achieve this by appending the following section to the configuration file:
```ini
[prompt_translate_to_french]
name = Translate to French
shortcut = t
system_prompt = "I want you to act as a French translator. I will say something in any language and you will translate it to French. The first thing I want you to translate is:"
temperature = 0.2
model = gpt-3.5-turbo
```
To ensure that the newly added prompt is available in the popup menu, it must be included in the `[popup_menu]` section. Additionally, if you have already configured multiple prompts, you can tidy up the popup menu by utilizing `---` as a separator.
```ini
[popup_menu]
---
prompt_translate_to_french
```
The changes will be applied automatically, there's no need to restart ChatKey (the only exception to this rule is the global `popup_menu_hotkey`).
### Prompt settings
You can individually configure the parameters of each prompt. If keys with default values are omitted, the default values will be used instead.
| Key | Description | Default |
| ------------------- | -------------------------------------------------------------------------------------------------------- | --------- |
| `name` | The name of the prompt that will be displayed in the popup menu | |
| `shortcut` | The shortcut key to select the prompt from the popup menu | |
| `system_content` | The prompt that will be used to generate the response (required) | |
| `model` | The model to use when generating the response, more info [here](https://platform.openai.com/docs/models) | `gpt-3.5` |
| `temperature` | The temperature to use when generating the response (0.0 - 2.0) | `0.7` |
| `top_p` | The top_p to use when generating the response (0.0 - 1.0) | |
| `presence_penalty` | Increase the model's likelihood to talk about new topics (-2.0 - 2.0) | |
| `frequency_penalty` | Decrease the model's likelihood to repeat the same line verbatim (-2.0 - 2.0) | |
## Acknowledgements
- [I versus AI](https://www.youtube.com/@IversusAI) for the awesome tutorial video
- [cocobelgica](https://github.com/cocobelgica) for the JSON lib
- [teadrinker](https://www.autohotkey.com/boards/viewtopic.php?t=113529) for the HBitmapFromResource lib
## License
The code in this repository is licensed under the MIT License. See [LICENSE](LICENSE) for more information.