Skip to content

Commit

Permalink
update models list and enhance readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamyodinsky committed Dec 26, 2024
1 parent 5f0de48 commit e12aa38
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 9 deletions.
39 changes: 31 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,16 @@ With terminalGPT, you can easily interact with the OpenAI GPT-3.5 and GPT-4 lang

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.

---

<img width="910" alt="image" src="https://user-images.githubusercontent.com/27074934/229319537-f332923d-f92e-4d91-8d5e-d26d8997341e.png">

---
### Supported Models

- gpt-3.5-turbo
- gpt-4-turbo
- gpt-4o
- gpt-4o-mini
- o1
- o1-mini

## Why?

Expand Down Expand Up @@ -74,10 +79,10 @@ Usage: terminalgpt [OPTIONS] COMMAND [ARGS]...
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]
-m, --model [gpt-3.5-turbo|gpt-4-turbo|gpt-4o|gpt-4o-mini|o1|o1-mini]
Choose a model to use. [default:
gpt-3.5-turbo]
-s, --style [markdown|plain] Output style. [default: markdown]
gpt-4o-mini]
-s, --style [markdown|plain] Output style. [default: plain]
-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.
Expand All @@ -98,14 +103,16 @@ Start a new conversation:
terminalgpt new
```

### One-Shot
### One-Shot (I love this feature)

One shot question to get a fast answer in the terminal.

```sh
terminalgpt one-shot "What is the meaning of life?"
```

**Note:** I recommend to make an alias, see at [Recommended aliases](#recommended-aliases).

### Load

Load previous conversations:
Expand All @@ -122,7 +129,23 @@ Delete previous conversations:
terminalgpt delete
```

---
## Recommended aliases

### Zsh

```sh
echo alias gpto="terminalgpt one-shot" >> ~/.zshrc
echo alias gptn="terminalgpt new" >> ~/.zshrc
```

### Bash

```sh
echo alias gpto="terminalgpt one-shot" >> ~/.zshrc
echo alias gptn="terminalgpt new" >> ~/.zshrc
```

## export

[![Star History Chart](https://api.star-history.com/svg?repos=adamyodinsky/TerminalGPT&type=Date)](https://star-history.com/#bytebase/star-history&Date)

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "terminalgpt"
version = "2.2.2"
version = "2.2.3"
description = "AI chat assistant in your terminal powered by OpenAI ChatGPT models."
authors = ["Adam Yodinsky <[email protected]>"]
keywords = [
Expand Down
2 changes: 2 additions & 0 deletions terminalgpt/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
"gpt-4-turbo": 16385, # can be 120000
"gpt-4o": 16385, # can be 120000
"gpt-4o-mini": 16385, # can be 120000
"o1": 16385,
"o1-mini": 16385,
}


Expand Down

0 comments on commit e12aa38

Please sign in to comment.