terminalgpt 2.2.8
AI chat assistant in your terminal powered by OpenAI ChatGPT models.
Requires Python: <4.0,>=3.9
Keywords: ai, chat, terminal, openai, chatGPT, terminalGPT, assistant, devops, tool, cli, gpt, gpt-3.5, gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-4, gpt-4-32k

# ![TerminalGPT](logo.png)

<!--- [![Continuous Integration](https://github.com/adamyodinsky/TerminalGPT/actions/workflows/MainCI.yml/badge.svg?branch=main)](https://github.com/adamyodinsky/TerminalGPT/actions/workflows/main.yml) --->

![PyPI](https://img.shields.io/pypi/v/terminalgpt) ![PyPI - Downloads](https://img.shields.io/pypi/dm/terminalgpt) ![commits-since](https://img.shields.io/github/commits-since/adamyodinsky/TerminalGPT/latest) ![GitHub last commit](https://img.shields.io/github/last-commit/adamyodinsky/terminalgpt)

Welcome to terminalGPT, the terminal-based ChatGPT personal assistant app!
With terminalGPT, you can easily interact with the OpenAI GPT-3.5, GPT-4, and GPT-5 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.

<img width="910" alt="image" src="https://user-images.githubusercontent.com/27074934/229319537-f332923d-f92e-4d91-8d5e-d26d8997341e.png">

### Supported Models

- gpt-3.5-turbo
- gpt-4-turbo
- gpt-4o
- gpt-4o-mini
- o1
- o1-mini
- gpt-5-mini

## Why?

Some advantages of using TerminalGPT:

- 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.
- Your conversations are stored locally on your machine, so only you can access them.
- Efficient context management for super cheap api usage.
- It's highly available and can be used whenever you need it.
- 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.
- Fast, reliable, lightweight.
- Quick one shot question mode.

## Pre-requisites

- Python 3.6 or higher
- An OpenAI Account and API key.
  1.  Sign up at <https://platform.openai.com/signup> using email or Google/Microsoft account.
  2.  Go to <https://platform.openai.com/account/api-keys> or click on "View API keys" in the menu to get your API key.

## Installation

### Using pip

1. Install the latest TerminalGPT with pip install.

```sh
pip install terminalgpt -U --user
```

or

```sh
pip3 install terminalgpt -U --user
```

### Using pipx

1. remove old installation that was installed with pip <br/>
   (do this only if you are migrating from a version that was installed with pip)

```sh
package_location=$(which terminalgpt)
rm "$package_location"
```

2. install with pipx

```sh
pipx install terminalgpt==2.2.7 --force
```

### Setup

1. Now you have `terminalgpt` command available in your terminal. Run the following install command to configure the app.

```sh
terminalgpt install
```

2. Enter your OpenAI API key when prompted and press enter.

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

4. 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-4-turbo|gpt-4o|gpt-4o-mini|o1|o1-mini|gpt-5-mini]
                                  Choose a model to use.  [default:
                                  gpt-4o-mini]
  -s, --style [markdown|plain]    Output style.  [default: plain]
  -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:

```sh
terminalgpt new
```

### One-Shot (I love this feature)

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

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

**Note:** I recommend to make an alias, see at [Recommended aliases](#recommended-aliases).

### Load

Load previous conversations:

```sh
terminalgpt load
```

### Delete

Delete previous conversations:

```sh
terminalgpt delete
```

## Recommended aliases

### Zsh

```sh
echo alias tgpt="terminalgpt" >> ~/.zshrc
echo alias tgpto="terminalgpt one-shot" >> ~/.zshrc
echo alias tgptn="terminalgpt new" >> ~/.zshrc
```

### Bash

```sh
echo alias tgpt="terminalgpt" >> ~/.bashrc
echo alias tgpto="terminalgpt one-shot" >> ~/.bashrc
echo alias tgptn="terminalgpt new" >> ~/.bashrc
```

---

[![Star History Chart](https://api.star-history.com/svg?repos=adamyodinsky/TerminalGPT&type=Date)](https://www.star-history.com/#adamyodinsky/TerminalGPT&Date)

---