See https://github.com/AineeJames/ChatGPTerminator for more details!
Project description
GPTerminator :robot: - ChatGPT in the Terminal!
GPTerminator provides a convenient way to interact with OpenAI's chat completion and image generation APIs using your command line interface.
Features :sparkles:
- :mag: Chat completion
- :floppy_disk: Save and load chat sessions
- :bar_chart: File analysis
- :art: Image generation with Dalle
- :clipboard: Easy code and text copying using
- :repeat: Regeneration of responses
Getting Started & Installation :rocket:
To use this terminal interface, follow these steps:
1) Install GPTerminator
git clone https://github.com/AineeJames/ChatGPTerminator
cd ChatGPTerminator
pip install .
or
pip install gpterminator
2) Set the OPENAI_API_KEY env variable (you may want this in your shell's .rc
file):
export OPENAI_API_KEY=<YOUR_API_KEY>
3) Run the following command to start the ChatGPT terminal interface:
gpterm
4) You can now start chatting. Type a message and press Enter to get a response.
5) Type !help
for a list of commands to use
Running with podman/docker (optional) :package:
Build the image and provide the APIKEY
podman build \
--build-arg APIKEY=$(echo $OPENAI_API_KEY) \
-t gpterm .
Run gpterm
in the container
podman run -it --rm --name gpterm gpterm
Set an alias for easy access
echo "alias gpterm='podman run -it --rm --name gpterm gpterm'" >> ~/.bashrc
Commands :exclamation:
- Power up you chat experience with commands!
- By typing
!help
you can view all the possible commands along with a short description. - Please check out the wiki for more detailed help with commands!
Configuration :gear:
The config.ini
configuration resides in different locations depending on your OS. In order to find the path, run gpterm
and then enter !pconf
.
GPTerminator is configurable and can support multiple configurations. Add the following to your config.ini
:
[CONFIG_TEMPLATE]
ModelName =
SystemMessage =
Temperature =
PresencePenalty =
FrequencyPenalty =
CommandInitiator =
SavePath =
CodeTheme =
Setting | Description | Default |
---|---|---|
ModelName | this is the model used when chatting | gpt-3.5-turbo |
Temperature | between 0 and 2 | 1 |
PresencePenalty | between -2 and 2 | 0 |
FrequencyPenalty | between -2 and 2 | 0 |
SystemMessage | this is the starting system message sent to the API | You are a helpful assistant named GPTerminator |
CommandInitiator | this can be set to change the default ! structure |
! |
SavePath | this changes the location of the save path when loading/saving | (default save path) |
CodeTheme | this changes the Pygments theme of code blocks | monokai |
Note More details on some settings can be found here
Note Valid color schemes can be found here
Note If you change the
CommandInitiator
, you will now type<new-command>
to execute commands...
After saving the config file, run gpterm
, then enter !setconf
and select which config you wish to use. You can also run the !pconf
command to view the current config details.
Contributing :raised_hands:
Current Contributors:
We welcome contributions to this project. If you find a bug, have a feature request, or want to contribute code, please open an issue or submit a pull request.
Disclaimer :warning:
Warning This program uses the OpenAI API to chat and generate images using DALL·E. It is a good idea to put a usage cap on your billing, just in case something goes wrong!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gpterminator-0.1.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ced606ff218676b3392124bb774e89b7a6afb71a460e7146c250fd475dd3647 |
|
MD5 | 64af35f8bc56fa25c22ebb65c2d39c37 |
|
BLAKE2b-256 | ec3b4df67f626e4ddad90e9985681effa0f1f31a933e1ff8d85e727eb88842b2 |