# 
[](https://github.com/adamyodinsky/TerminalGPT/actions/workflows/main.yml)    
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.
---
<img width="910" alt="image" src="https://user-images.githubusercontent.com/27074934/229319537-f332923d-f92e-4d91-8d5e-d26d8997341e.png">
---
## 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
- Python 3.6 or higher
- An OpenAI Account and API key.
1. Sign up at <https://beta.openai.com/signup> using email or Google/Microsoft account.
2. Go to <https://beta.openai.com/account/api-keys> or click on "View API keys" in the menu to get your API key.
## Installation
1. Install the latest TerminalGPT with pip install.
```sh
pip install terminalgpt -U --user
```
or
```sh
pip3 install terminalgpt -U --user
```
2. Now you have `terminalgpt` command available in your terminal. Run the following install command to configure the app.
```sh
terminalgpt install
```
3. Enter your OpenAI API key when prompted and press enter.
4. Choose one of the models below as the default model. it can be overridden with the `-m --model` flag later.
5. 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:
```sh
terminalgpt new
```
### One-Shot
One shot question to get a fast answer in the terminal.
```sh
terminalgpt one-shot "What is the meaning of life?"
```
### Load
Load previous conversations:
```sh
terminalgpt load
```
### Delete
Delete previous conversations:
```sh
terminalgpt delete
```
---
[](https://star-history.com/#bytebase/star-history&Date)
---
Raw data
{
"_id": null,
"home_page": null,
"name": "terminalgpt",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"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",
"author": "Adam Yodinsky",
"author_email": "27074934+adamyodinsky@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/54/a3/2ad4ef6aebc2913d47af32927825c84393a04196b2763ff44c13a512e06d/terminalgpt-2.2.2.tar.gz",
"platform": null,
"description": "# \n\n[](https://github.com/adamyodinsky/TerminalGPT/actions/workflows/main.yml)    \n\nWelcome to terminalGPT, the terminal-based ChatGPT personal assistant app!\nWith terminalGPT, you can easily interact with the OpenAI GPT-3.5 and GPT-4 language models.\n\nWhether 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.\n\n---\n\n<img width=\"910\" alt=\"image\" src=\"https://user-images.githubusercontent.com/27074934/229319537-f332923d-f92e-4d91-8d5e-d26d8997341e.png\">\n\n---\n\n## Why?\n\nSome advantages of using TerminalGPT over the chatGPT browser-based app:\n\n- 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.\n- It's highly available and can be used whenever you need it.\n- It's faster with replies than the browser-based app.\n- 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.\n- TerminalGPT's answers are tailored to your machine's operating system, distribution, and chip-set architecture\n- Doesn't use your conversation data for training the model (unlike the browser-based app).\n- Your conversations are stored locally on your machine, so only you can access them.\n\n## Pre-requisites\n\n- Python 3.6 or higher\n- An OpenAI Account and API key.\n 1. Sign up at <https://beta.openai.com/signup> using email or Google/Microsoft account.\n 2. Go to <https://beta.openai.com/account/api-keys> or click on \"View API keys\" in the menu to get your API key.\n\n## Installation\n\n1. Install the latest TerminalGPT with pip install.\n\n```sh\npip install terminalgpt -U --user\n```\n\nor\n\n```sh\npip3 install terminalgpt -U --user\n```\n\n2. Now you have `terminalgpt` command available in your terminal. Run the following install command to configure the app.\n\n```sh\nterminalgpt install\n```\n\n3. Enter your OpenAI API key when prompted and press enter.\n\n4. Choose one of the models below as the default model. it can be overridden with the `-m --model` flag later.\n\n5. Choose a printing style\n\nThat's it! You're ready to use TerminalGPT!\nYou 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`.\n\n---\n\n## Usage\n\n### TL;DR\n\n```\nUsage: terminalgpt [OPTIONS] COMMAND [ARGS]...\n\n *~ TerminalGPT - Your Personal Terminal Assistant ~*\n\nOptions:\n --version Show the version and exit.\n -m, --model [gpt-3.5-turbo|gpt-3.5-turbo-16k|gpt-4|gpt-4-32k|gpt-4-turbo|gpt-4o]\n Choose a model to use. [default:\n gpt-3.5-turbo]\n -s, --style [markdown|plain] Output style. [default: markdown]\n -t, --token-limit INTEGER Set the token limit. this will override the\n default token limit for the chosen model.\n --help Show this message and exit.\n\nCommands:\n delete Choose a previous conversation to delete.\n install Installing the OpenAI API key and setup some default settings.\n load Choose a previous conversation to load.\n new Start a new conversation.\n one-shot One shot question answer.\n```\n\n### New\n\nStart a new conversation:\n\n```sh\nterminalgpt new\n```\n\n### One-Shot\n\nOne shot question to get a fast answer in the terminal.\n\n```sh\nterminalgpt one-shot \"What is the meaning of life?\"\n```\n\n### Load\n\nLoad previous conversations:\n\n```sh\nterminalgpt load\n```\n\n### Delete\n\nDelete previous conversations:\n\n```sh\nterminalgpt delete\n```\n\n---\n\n[](https://star-history.com/#bytebase/star-history&Date)\n\n---\n",
"bugtrack_url": null,
"license": null,
"summary": "AI chat assistant in your terminal powered by OpenAI ChatGPT models.",
"version": "2.2.2",
"project_urls": null,
"split_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"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07f925e3f021726d10f3b4ace78d22bfb9864482eaf6e6c5de4172ce9169b542",
"md5": "39f9f3f7d1db9db2f59340ec87f0ee41",
"sha256": "901cec1a0053fdb31772a28364965ee0815e8dd8997bc4c032a4695dcd9b2e1a"
},
"downloads": -1,
"filename": "terminalgpt-2.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39f9f3f7d1db9db2f59340ec87f0ee41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 16211,
"upload_time": "2024-08-25T09:57:08",
"upload_time_iso_8601": "2024-08-25T09:57:08.553792Z",
"url": "https://files.pythonhosted.org/packages/07/f9/25e3f021726d10f3b4ace78d22bfb9864482eaf6e6c5de4172ce9169b542/terminalgpt-2.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "54a32ad4ef6aebc2913d47af32927825c84393a04196b2763ff44c13a512e06d",
"md5": "c81a0460adaa2006d6646f025704f3d1",
"sha256": "898a33bda8053a9ef88722d5f511aed6b3bfdf0da1f19bef148de01ef1ecf773"
},
"downloads": -1,
"filename": "terminalgpt-2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "c81a0460adaa2006d6646f025704f3d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 14710,
"upload_time": "2024-08-25T09:57:10",
"upload_time_iso_8601": "2024-08-25T09:57:10.032888Z",
"url": "https://files.pythonhosted.org/packages/54/a3/2ad4ef6aebc2913d47af32927825c84393a04196b2763ff44c13a512e06d/terminalgpt-2.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 09:57:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "terminalgpt"
}
JSON