Skip to main content

AI chat asistent in your terminal powered by OpenAI GPT-3.5

Project description

TerminalGPT

Continuous Integration PyPI PyPI - Downloads commits-since GitHub last commit

Welcome to terminalGPT, the terminal-based ChatGPT personal assistant app! With terminalGPT, you can easily interact with the OpenAI GPT 3.5 language model.

Whether you need help with a quick question or want to explore a complex topic, TerminalGPT is here to assist you. Simply enter your query and TerminalGPT will provide you with the best answer possible based on its extensive knowledge base.


Alt Text


Why?

Some advantages of using TerminalGPT over the chatGPT browser-based app:

  1. It doesn't disconnect like the browser-based app, so you can leave it running in a terminal session on the side without losing context.
  2. It's highly available and can be used whenever you need it.
  3. It's faster with replies than the browser-based app.
  4. You can use TerminalGPT with your IDE terminal, which means you won't have to constantly switch between your browser and your IDE when you have questions.
  5. TerminalGPT's answers are tailored to your machine's operating system, distribution, and chip-set architecture.
  6. Doesn't use your conversation data for training the model (unlike the browser-based app).
  7. Your conversations are stored locally on your machine, so only you can access them.

Pre-requisites

  1. Python 3.6 or higher
  2. An OpenAI Account and API key (It's free for personal use). How to create OpenAI API keys

Installation

  1. Install the latest TerminalGPT with pip install.
pip install terminalgpt -U
  1. Now you have terminalgpt command available in your terminal. Run the following install command to configure the app.
terminalgpt install
  1. Enter your OpenAI API key when prompted and press enter.

That's it! You're ready to use TerminalGPT!


Usage

Usage: terminalgpt [OPTIONS] COMMAND [ARGS]...

Options:
  --debug                Prints amounts of tokens used.
  --token-limit INTEGER  Set the token limit between 1024 and 4096.
  --help                 Show this message and exit.

Commands:
  new      Start a new conversation.
  load     Choose a previous conversation to load.
  delete   Choose a previous conversation to load.
  install  Creating a secret api key for the chatbot.

New

Start a new conversation:

terminalgpt new

Load

Load previous conversations:

terminalgpt load

Delete

Delete previous conversations:

terminalgpt delete

Using flags

Using flags, you can set the token limit and debug mode. the flags should be used before the command.

For example:

terminalgpt --token-limit 2048 --debug new

Future Plans

  1. Support multiline input.
  2. Support optional vim input mode.
  3. Auto-completion for all commands.
  4. Open source the project.
  5. Add more models (???)
  6. Encrypt the conversation data.
  7. Migrating to Typer

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

terminalgpt-1.0.6.tar.gz (11.3 kB view hashes)

Uploaded Source

Built Distribution

terminalgpt-1.0.6-py3-none-any.whl (13.0 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