Skip to content

Latest commit

 

History

History
129 lines (85 loc) · 4.31 KB

README.md

File metadata and controls

129 lines (85 loc) · 4.31 KB
Raw

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 and GPT-4 language models.

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.

image

Why?

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

  • 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.
  • It's highly available and can be used whenever you need it.
  • It's faster with replies than the browser-based app.
  • 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.
  • TerminalGPT's answers are tailored to your machine's operating system, distribution, and chip-set architecture
  • Doesn't use your conversation data for training the model (unlike the browser-based app).
  • Your conversations are stored locally on your machine, so only you can access them.

Pre-requisites

Installation

  1. Install the latest TerminalGPT with pip install.
pip install terminalgpt -U --user

or

pip3 install terminalgpt -U --user
  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.

  2. Choose one of the models below as the default model. it can be overridden with the -m --model flag later.

  3. Choose a printing style

That's it! You're ready to use TerminalGPT! You can now start a new conversation with terminalgpt new or load a previous conversation with terminalgpt load. Also you can reinstall with terminalgpt install or delete previous conversations with terminalgpt delete.

Usage

TL;DR

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

  *~ TerminalGPT - Your Personal Terminal Assistant ~*

Options:
  --version                       Show the version and exit.
  -m, --model [gpt-3.5-turbo|gpt-3.5-turbo-16k|gpt-4|gpt-4-32k|gpt-4-turbo|gpt-4o]
                                  Choose a model to use.  [default:
                                  gpt-3.5-turbo]
  -s, --style [markdown|plain]    Output style.  [default: markdown]
  -t, --token-limit INTEGER       Set the token limit. this will override the
                                  default token limit for the chosen model.
  --help                          Show this message and exit.

Commands:
  delete    Choose a previous conversation to delete.
  install   Installing the OpenAI API key and setup some default settings.
  load      Choose a previous conversation to load.
  new       Start a new conversation.
  one-shot  One shot question answer.

New

Start a new conversation:

terminalgpt new

One-Shot

One shot question to get a fast answer in the terminal.

terminalgpt one-shot "What is the meaning of life?"

Load

Load previous conversations:

terminalgpt load

Delete

Delete previous conversations:

terminalgpt delete

Star History Chart