AI chat assistant in your terminal powered by OpenAI ChatGPT models.
Project description
[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.
- Sign up at https://beta.openai.com/signup using email or Google/Microsoft account.
- Go to https://beta.openai.com/account/api-keys or click on "View API keys" in the menu to get your API key.
Installation
- Install the latest TerminalGPT-Pro with pip install.
pip install terminalgpt (optional -U --user)
- Now you have
terminalgpt
command available in your terminal. Run the following install command to configure the app.
terminalgpt install
-
Enter your OpenAI API key when prompted and press enter.
-
Choose one of the models below as the default model. it can be overridden with the
-m --model
flag later. -
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
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:
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for terminalgpt_pro-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 404856709ce0bde01e26c5aa087dbd1c13c00cd8b780fc5a90d7406b90608b6e |
|
MD5 | 6d87a6c740cad09a1939c0c3289ca072 |
|
BLAKE2b-256 | 843e2d175b8ad2df759b6413e63cbb5eecdfc54468b1a29e85dad17cd8625de9 |