Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jucasoliveira/terminalgpt
Get GPT like chatGPT on your terminal
https://github.com/jucasoliveira/terminalgpt
ai bash chatgpt chatgpt-api cli typescript
Last synced: 3 months ago
JSON representation
Get GPT like chatGPT on your terminal
- Host: GitHub
- URL: https://github.com/jucasoliveira/terminalgpt
- Owner: jucasoliveira
- License: mit
- Created: 2023-01-05T07:25:12.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-22T21:40:43.000Z (about 1 year ago)
- Last Synced: 2024-05-22T11:31:44.829Z (9 months ago)
- Topics: ai, bash, chatgpt, chatgpt-api, cli, typescript
- Language: TypeScript
- Homepage:
- Size: 711 KB
- Stars: 983
- Watchers: 11
- Forks: 181
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ChatGPT-repositories - terminalGPT - Get GPT like chatGPT on your terminal (CLIs)
README
Get GPT-like chatGPT on your terminal
## Stats
## Prerequisites
You'll need to have your own `OpenAi` apikey to operate this package.
1. Go to
2. Select your profile menu and go to `View API Keys`
3. Select `+ Create new secret key`
4. Copy generated key
# Installation
Install terminalGPT globally:
```bash
npm -g install terminalgpt
```
or
```bash
yarn global add terminalgpt
```
## Start chat
```bash
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**.
## Options
### Change engine and temperature
```bash
tgpt chat --engine "gpt-4" --temperature 0.7
```
Note this library uses [Chat Completions API](https://platform.openai.com/docs/api-reference/chat).
The `engine` parameter is the same as the `model` parameter in the API. The default value is `gpt-3.5-turbo`.
### Use markdown
```bash
tgpt chat --markdown
```
## Change or delete api key
It you are not satisfied or added a wrong api key, run
```bash
tgpt delete
```
## Using with npx
```bash
npx terminalgpt
```
```bash
npx terminalgpt
```
Note `npx terminalgpt` doesn't install the terminalgpt package, instead it downloads the package to your computer 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`
## Contributing
Refer to CONTRIBUTING.md 😎
## ✨ Contributors
