tgpt

README

Terminal GPT (tgpt) 🚀

tgpt is a cross-platform command-line interface (CLI) tool that allows you to use AI chatbot in your Terminal without requiring API keys.

Currently available providers:

• FakeOpen (GPT-3.5-turbo, GPT-4)
• Brave Leo (llama-2-13b-chat)
• OpenGPTs (GPT-3.5-turbo)
• OpenAI (Requires API Key)

Image Generation Model: Craiyon V3

Usage 💬

Usage: tgpt [Flags] [Prompt]

Flags:
-s, --shell                                        Generate and Execute shell commands. (Experimental) 
-c, --code                                         Generate Code. (Experimental)
-q, --quiet                                        Gives response back without loading animation
-w, --whole                                        Gives response back as a whole text
-img, --image                                      Generate images from text
--provider                                         Set Provider. Detailed information has been provided below

Some additional options can be set. However not all options are supported by all providers. Not supported options will just be ignored.
--model                                            Set Model
--key                                              Set API Key
--temperature                                      Set temperature
--top_p                                            Set top_p
--max_length                                       Set max response length

Options:
-v, --version                                      Print version 
-h, --help                                         Print help message 
-i, --interactive                                  Start normal interactive mode 
-m, --multiline                                    Start multi-line interactive mode 
-cl, --changelog                                   See changelog of versions 
-u, --update                                       Update program 

Providers:
The default provider is fakeopen which uses 'GPT-3.5-turbo' model.
Available providers to use: leo, fakeopen, openai, opengpts, koboldai

Provider: leo
Supports personal API Key and custom models.

Provider: fakeopen
No support for API Key, but supports models. Default model is gpt-3.5-turbo. Supports gpt-4

Provider: openai
Needs API key to work and supports various models

Provider: opengpts
Uses gpt-3.5-turbo only. Do not use with sensitive data

Provider: koboldai
Uses koboldcpp/HF_SPACE_Tiefighter-13B only, answers from novels

Examples:
tgpt "What is internet?"
tgpt -m
tgpt -s "How to update my system?"
tgpt --provider fakeopen "What is 1+1"
tgpt --provider openai --key "sk-xxxx" --model "gpt-3.5-turbo" "What is 1+1"

Installation ⏬

Download for GNU/Linux 🐧 or MacOS 🍎

The default download location is /usr/local/bin, but you can change it in the command to use a different location. However, make sure the location is added to your PATH environment variable for easy accessibility.

You can download it with the following command:

curl -sSL https://raw.githubusercontent.com/aandrew-me/tgpt/main/install | bash -s /usr/local/bin

If you are using Arch Linux, you can install the AUR package with paru:

paru -S tgpt-bin

Or with yay:

yay -S tgpt-bin

Install with Go

go install github.com/aandrew-me/tgpt/v2@latest

Windows 🪟

• Scoop: Package installation with Scoop can be done using the following command:

  scoop install https://raw.githubusercontent.com/aandrew-me/tgpt/main/tgpt.json
  

Proxy

Support:

• Http Proxy [ http://ip:port ]
• Http Auth [ http://user:pass@ip:port ]
• Socks5 Proxy [ socks5://ip:port ]
• Socks5 Auth [ socks5://user:pass@ip:port ]

If you want to use a proxy, create proxy.txt file in the same directory where the program is located and write your proxy configuration there.

Example:

http://127.0.0.1:8080

From Release

You can download the executable for your operating system, rename it to tgpt (or any other desired name), and then execute it by typing ./tgpt while in that directory. Alternatively, you can add it to your PATH environmental variable and then execute it by simply typing tgpt.

Uninstalling

If you installed with the install script, you can execute the following command to remove the tgpt executable

sudo rm $(which tgpt)

Configuration file is usually located in ~/.config/tgpt on GNU/Linux Systems and in "Library/Application Support/tgpt" on MacOS