Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamyodinsky/TerminalGPT
TerminalGPT - Terminal-based ChatGPT personal assistant app. Provides optimized, tailored answers for your machine's terminal.
https://github.com/adamyodinsky/TerminalGPT
ai assistant chatgpt generative-ai generative-model gpt gpt-3 gpt-3-5-turbo gpt-35-turbo gpt-4 gpt3-prompts gptchat openai terminal terminalgpt
Last synced: 3 months ago
JSON representation
TerminalGPT - Terminal-based ChatGPT personal assistant app. Provides optimized, tailored answers for your machine's terminal.
- Host: GitHub
- URL: https://github.com/adamyodinsky/TerminalGPT
- Owner: adamyodinsky
- License: mit
- Created: 2023-03-02T17:10:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-23T22:35:58.000Z (8 months ago)
- Last Synced: 2024-04-24T01:20:52.250Z (7 months ago)
- Topics: ai, assistant, chatgpt, generative-ai, generative-model, gpt, gpt-3, gpt-3-5-turbo, gpt-35-turbo, gpt-4, gpt3-prompts, gptchat, openai, terminal, terminalgpt
- Language: Python
- Homepage:
- Size: 1.19 MB
- Stars: 105
- Watchers: 3
- Forks: 14
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-starz - adamyodinsky/TerminalGPT - TerminalGPT - Terminal-based ChatGPT personal assistant app. Provides optimized, tailored answers for your machine's terminal. (Python)
README
# 
[](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.
---
---
## 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 using email or Google/Microsoft account.
2. Go to 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 ('markdown' is recommended and suggested by default)
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)
---