Skip to main content

AI chat assistant in your terminal powered by OpenAI ChatGPT models.

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 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


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-2.2.2.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

terminalgpt-2.2.2-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file terminalgpt-2.2.2.tar.gz.

File metadata

  • Download URL: terminalgpt-2.2.2.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.10 Darwin/23.6.0

File hashes

Hashes for terminalgpt-2.2.2.tar.gz
Algorithm Hash digest
SHA256 898a33bda8053a9ef88722d5f511aed6b3bfdf0da1f19bef148de01ef1ecf773
MD5 c81a0460adaa2006d6646f025704f3d1
BLAKE2b-256 54a32ad4ef6aebc2913d47af32927825c84393a04196b2763ff44c13a512e06d

See more details on using hashes here.

File details

Details for the file terminalgpt-2.2.2-py3-none-any.whl.

File metadata

  • Download URL: terminalgpt-2.2.2-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.10 Darwin/23.6.0

File hashes

Hashes for terminalgpt-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 901cec1a0053fdb31772a28364965ee0815e8dd8997bc4c032a4695dcd9b2e1a
MD5 39f9f3f7d1db9db2f59340ec87f0ee41
BLAKE2b-256 07f925e3f021726d10f3b4ace78d22bfb9864482eaf6e6c5de4172ce9169b542

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