README.md

Get GPT like chatGPT on your terminal

Pre-requisite

You'll need to have your own OpenAi apikey to operate this package.

1. Go to https://beta.openai.com/
2. Select you profile menu and go to Manage API Keys
3. Select + Create new secret key
4. Copy generated key

Get Started

Using tgpt

npm -g install terminalgpt

or

yarn global add terminalgpt

Run

tgpt chat

ps.: If it is your first time running it, it will ask for open AI key , paste generated key from pre-requisite steps

Changing engine and temperature

tgpt chat --engine "text-davinci-002" --temperature 0.7

Changing api key

It you are not satisfy or added a wrong api key , run

tgpt delete

Using with npx

npx terminalgpt

Run

npx terminalgpt chat

ps.: If it is your first time running it, it will ask for open AI key , paste generated key from pre-requisite steps

Changing engine and temperature

npx terminalgpt chat --engine "text-davinci-002" --temperature 0.7

Changing api key

If you are not satisfied or entered a wrong api key, run

npx terminalgpt delete

😎 Contribute your first spec in < 3 minutes

Use the steps below:

Steps

1. Click here to fork this repo.

2. Clone your forked repo and create an example spec

   # Replace `YOUR_GITHUB_USERNAME` with your own github username
   git clone https://github.com/YOUR_GITHUB_USERNAME/terminalGPT.git terminalGPT
   cd terminalGPT
   
   # Add jucasoliveira/terminalGPT as a remote
   git remote add upstream https://github.com/jucasoliveira/terminalGPT.git
   
   # Install packages
   npm install
   

3. On your terminal, type npm run chat. Your terminalGPT will start. 😊

Extra / Remove from your computer

'npx terminalgpt' doesn't install the terminalgpt package, instead it downloads the package to your pc and directly executes it from the cache.

You can find the package using

ls ~/.npm/_npx/*/node_modules

To delete the package, you can use

rm -r ~/.npm/_npx/*/node_modules/terminalgpt

✨ Contributors