Skip to content

Commit d213db0

Browse files
committed
Update readme, docstring
1 parent b71398f commit d213db0

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Gptcmd allows you to interact with large language models, such as OpenAI's GPT,
44
## Getting started
55
Gptcmd requires [Python](https://python.org) 3.7.1. Python 3.8.6 or later is strongly recommended and will be required to run future releases. Gptcmd is available on PyPI, and can, for instance, be installed with `pip install gptcmd` at a command line shell. Running `gptcmd` at a shell starts the application. If Python's `bin` or `scripts` directory isn't on your path, you may need to launch the application with a command like `~/.local/bin/gptcmd` (depending on your system configuration). In most cases though, `gptcmd` should "just work".
66

7-
If you'd like to use OpenAI models and you don't have an OpenAI account, you'll need to create one and [add some credit](https://platform.openai.com/account/billing/overview). $5 or so goes very far, especially on `gpt-4o-mini`.
7+
If you'd like to use OpenAI models and you don't have an OpenAI account, you'll need to create one and [add some credit](https://platform.openai.com/account/billing/overview). $5 or so goes very far, [especially on `gpt-4o-mini`](#model-selection).
88

99
Gptcmd searches for provider credentials in its configuration file, falling back to the `OPENAI_API_KEY` environment variable if no key is provided in its configuration. If you'd like to use OpenAI models and you don't have an API key, you'll need to [generate a key](https://platform.openai.com/account/api-keys).
1010

@@ -172,7 +172,7 @@ Similarly, user and assistant messages can be added with the `user` and `assista
172172

173173
```
174174
(gpt-4o) user What are the first five Fibonacci numbers?
175-
'What are the first five Fibanacci numbers?' added as user
175+
'What are the first five Fibonacci numbers?' added as user
176176
(gpt-4o) assistant 1, 1, 2, 3, 5.
177177
'1, 1, 2, 3, 5.' added as assistant
178178
(gpt-4o) say And the next five?
@@ -313,7 +313,7 @@ If pi were equal to three point one four six two eight, then pi would be rationa
313313
Therefore, we conclude that pi is not exactly equal to three point one four six two eight.
314314
```
315315

316-
The `edit` command with no arguments opens the contents of the last message in an external text editor for editing. Providing the index of a message to `edit` as an argument edits that message.
316+
The `edit` command with no arguments opens the contents of the last message in an external text editor for modification. Providing the index of a message to `edit` as an argument edits that message.
317317

318318
### Message streaming
319319
The `stream` command toggles message streaming. By default, streaming is enabled, so long responses from the language model are output in real time as they are generated. While a message is being streamed, pressing <kbd>Control</kbd>+<kbd>c</kbd> causes Gptcmd to stop waiting for the message to generate fully, allowing other commands to be used. When streaming is disabled, Gptcmd retrieves an entire response for each query and displays it when it arrives.
@@ -411,8 +411,8 @@ The `set` command with no arguments shows all set API parameters:
411411

412412
```
413413
(gpt-4o) set
414-
temperature: 2
415414
max_tokens: 30
415+
temperature: 2
416416
timeout: 0.25
417417
(gpt-4o) unset
418418
Unset all parameters

src/gptcmd/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1177,7 +1177,7 @@ def _edit_interactively(
11771177
def do_edit(self, arg):
11781178
"""
11791179
Opens the content of the specified message in an external editor for
1180-
editing. With no argument, edits the last message.
1180+
modification. With no argument, edits the last message.
11811181
"""
11821182
try:
11831183
idx = (

0 commit comments

Comments
 (0)