Skip to main content

See https://github.com/AineeJames/ChatGPTerminator for more details!

Project description

GPTerminator :robot:

This terminal interface provides a convenient way to interact with OpenAI's chat completion and image generation API's using your command line interface.

Getting Started :rocket:

To use this terminal interface, follow these steps:

  1. Either clone this repository to your local machine and run pip install . or install it from PyPi by running pip install gpterminator

  2. Set the OPENAI_API_KEY env variable (you may want this in your .rc file): export OPENAI_API_KEY=PUT_API_KEY_HERE

  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

Usage :bulb:

Configuration :gear:

The config.ini directory resides in different locations dependent on your OS. In order to find the path, run GPTerminator and then type !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 = 
  • ModelName: this is the model used when chatting
  • Temperature = between 0 and 2
  • PresencePenalty = between -2 and 2
  • FrequencyPenalty = between -2 and 2
  • SystemMessage: this is the starting system message sent to the API
  • CommandInitiator: this can be set to change the default ! structure
  • SavePath: this changes the location of the save path when loading/saving

Note: More details on some settings can be found here

After saving the config file, run: gpterm Then, type !setconf and select which config you wish to use, you can also run the !pconf commang to view the current config details.

Note: If you change the CommandInitiator, you will now type to execute commands...

Contributing :raised_hands:

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:

This program uses the openai API to chat and generate images using dalle. It is a good idea to put a usage cap on your billing, just in case something goes wrong!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gpterminator-0.1.5.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

gpterminator-0.1.5-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file gpterminator-0.1.5.tar.gz.

File metadata

  • Download URL: gpterminator-0.1.5.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for gpterminator-0.1.5.tar.gz
Algorithm Hash digest
SHA256 1529449059e80d8ca6a09c8ac88dcddd3e8c581a019692b8da57b4d8b749f4b8
MD5 73fcb39de4fdb5c9d35081588c4a4a20
BLAKE2b-256 ea46bcf1c465edf5ce767aab7f07d2f1e4ca27743c9722bab99770804261b1c5

See more details on using hashes here.

File details

Details for the file gpterminator-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for gpterminator-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a4ff92eae98c24b9cbddae528cb3bd03ab13194ca9e09ac01a071551b76dce72
MD5 3fc7e6d489ee873e214372de84f349d1
BLAKE2b-256 35d4ebacabe36aab1f7e58f7e228f1e93c048a55727e64e726d18340feeda431

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page