Skip to main content

See the README 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. Clone this repository to your local machine.

  2. Navigate to the cloned directory using your command line interface.

  3. Install GPTerminator by using the following command: pip install .

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

  5. Run the following command to start the ChatGPT terminal interface: gpterm

  6. You can now start chatting. Type a message and press Enter to get a response.

  7. Type !help for a list of commands to use

Configuration :gear:

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.2.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

gpterminator-0.1.2-py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 3

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