Skip to content

Commit e7a0ca6

Browse files
committed
docs: added stats and links, updated usage
1 parent 4e7dc71 commit e7a0ca6

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ Usage: gptme [OPTIONS] [PROMPT]
8585

8686
.continue Continue.
8787
.undo Undo the last action.
88+
.log Show the conversation log.
8889
.summarize Summarize the conversation so far.
8990
.load Load a file.
9091
.shell Execute a shell command.
@@ -94,14 +95,37 @@ Usage: gptme [OPTIONS] [PROMPT]
9495
.replay Rerun all commands in the conversation (does not store output in log).
9596

9697
Options:
97-
--prompt-system TEXT System prompt. Can be 'full', 'short', or something
98-
custom.
99-
--name TEXT Name of conversation. Defaults to asking for a name,
100-
optionally letting the user choose to generate a
101-
random name.
102-
--llm [openai|llama] LLM to use.
103-
--stream / --no-stream Stream responses
104-
-v, --verbose Verbose output.
105-
-y, --no-confirm Skips all confirmation prompts.
106-
--help Show this message and exit.
98+
--prompt-system TEXT System prompt. Can be 'full', 'short', or
99+
something custom.
100+
--name TEXT Name of conversation. Defaults to asking for
101+
a name, optionally letting the user choose
102+
to generate a random name.
103+
--llm [openai|llama] LLM to use.
104+
--model [gpt-4|gpt-3.5-turbo|wizardcoder-...]
105+
Model to use (gpt-3.5 not recommended)
106+
--stream / --no-stream Stream responses
107+
-v, --verbose Verbose output.
108+
-y, --no-confirm Skips all confirmation prompts.
109+
--show-hidden Show hidden system messages.
110+
--help Show this message and exit.
107111
```
112+
113+
114+
## Stats
115+
116+
### Stargazers over time
117+
118+
[![Stargazers over time](https://starchart.cc/ErikBjare/gptme.svg)](https://starchart.cc/ErikBjare/gptme)
119+
120+
### Downloads
121+
122+
- [PePy](https://pepy.tech/project/gptme-python)
123+
- ![Downloads all-time](https://static.pepy.tech/badge/gptme-python)
124+
- ![Downloads per week](https://static.pepy.tech/badge/gptme-python/week)
125+
- [PyPiStats](https://pypistats.org/packages/gptme-python)
126+
127+
## Links
128+
129+
- [Twitter announcement](https://twitter.com/ErikBjare/status/1699097896451289115)
130+
- [Reddit announcement](https://www.reddit.com/r/LocalLLaMA/comments/16atlia/gptme_a_fancy_cli_to_interact_with_llms_gpt_or/)
131+
- [HN announcement](https://news.ycombinator.com/item?id=37394845)

0 commit comments

Comments
 (0)