# [TerminalGPT-Pro]
Welcome to TerminalGPT-Pro, the terminal-based ChatGPT personal assistant app!
With TerminalGPT-Pro, 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-Pro is here to assist you. Simply enter your query and TerminalGPT-Pro will provide you with the best answer possible based on its extensive knowledge base.
## Why?
Some advantages of using TerminalGPT-Pro 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-Pro with your IDE terminal, which means you won't have to constantly switch between your browser and your IDE when you have questions.
- TerminalGPT-Pro'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-Pro with pip install.
```sh
pip install terminalgpt (optional -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 ('markdown' is recommended)
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
```sh
Usage: terminalgpt [OPTIONS] COMMAND [ARGS]...
*~ TerminalGPT-Pro - 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]
Choose a model to use. [default:gpt-3.5-turbo]
-s, --style [markdown|plain] Output style. [default: markdown]
--help Show this message and exit.
Commands:
delete Choose a previous conversation to delete.
install Creating a secret api key for the chatbot.
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
```
Raw data
{
"_id": null,
"home_page": "",
"name": "terminalgpt-pro",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "ai,chat,terminal,openai,gpt-3,gpt-4,gpt4,gpt3,chatGPT,assistant,gpt-3.5,gpt-3.5-turbo,terminalGPT-Pro",
"author": "Adam Yodinsky, Shabernev Fedor",
"author_email": "quantumstack01@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6e/3a/dd0cf8799955427ae7cac852b77249b03da85d388969801bac5c88f61557/terminalgpt-pro-0.4.0.tar.gz",
"platform": null,
"description": "# [TerminalGPT-Pro]\n\n\nWelcome to TerminalGPT-Pro, the terminal-based ChatGPT personal assistant app!\nWith TerminalGPT-Pro, 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-Pro is here to assist you. Simply enter your query and TerminalGPT-Pro will provide you with the best answer possible based on its extensive knowledge base.\n\n\n## Why?\n\nSome advantages of using TerminalGPT-Pro 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-Pro 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-Pro'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-Pro with pip install.\n\n```sh\npip install terminalgpt (optional -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 ('markdown' is recommended)\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```sh\nUsage: terminalgpt [OPTIONS] COMMAND [ARGS]...\n\n *~ TerminalGPT-Pro - 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]\n Choose a model to use. [default:gpt-3.5-turbo]\n -s, --style [markdown|plain] Output style. [default: markdown]\n --help Show this message and exit.\n\nCommands:\n delete Choose a previous conversation to delete.\n install Creating a secret api key for the chatbot.\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",
"bugtrack_url": null,
"license": "",
"summary": "AI chat assistant in your terminal powered by OpenAI ChatGPT models.",
"version": "0.4.0",
"project_urls": null,
"split_keywords": [
"ai",
"chat",
"terminal",
"openai",
"gpt-3",
"gpt-4",
"gpt4",
"gpt3",
"chatgpt",
"assistant",
"gpt-3.5",
"gpt-3.5-turbo",
"terminalgpt-pro"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "843e2d175b8ad2df759b6413e63cbb5eecdfc54468b1a29e85dad17cd8625de9",
"md5": "6d87a6c740cad09a1939c0c3289ca072",
"sha256": "404856709ce0bde01e26c5aa087dbd1c13c00cd8b780fc5a90d7406b90608b6e"
},
"downloads": -1,
"filename": "terminalgpt_pro-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d87a6c740cad09a1939c0c3289ca072",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 19668,
"upload_time": "2023-11-20T10:27:30",
"upload_time_iso_8601": "2023-11-20T10:27:30.268150Z",
"url": "https://files.pythonhosted.org/packages/84/3e/2d175b8ad2df759b6413e63cbb5eecdfc54468b1a29e85dad17cd8625de9/terminalgpt_pro-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e3add0cf8799955427ae7cac852b77249b03da85d388969801bac5c88f61557",
"md5": "8d2eaef9afcb80f3875f5fe7ebbbec80",
"sha256": "7b5bbdc761f755685655abcebf37cb14f2d44d9542839f376580e4bc0b117a7d"
},
"downloads": -1,
"filename": "terminalgpt-pro-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "8d2eaef9afcb80f3875f5fe7ebbbec80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 13927,
"upload_time": "2023-11-20T10:27:36",
"upload_time_iso_8601": "2023-11-20T10:27:36.871308Z",
"url": "https://files.pythonhosted.org/packages/6e/3a/dd0cf8799955427ae7cac852b77249b03da85d388969801bac5c88f61557/terminalgpt-pro-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-20 10:27:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "terminalgpt-pro"
}
JSON