Skip to content

Commit

Permalink
improve README
Browse files Browse the repository at this point in the history
(closing parenthesis & formatting)

Signed-off-by: Manfred Hanke <[email protected]>
  • Loading branch information
hankem authored and thomas-endres-tng committed Apr 7, 2023
1 parent b0899b6 commit 7741d75
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ This will call GPT to generate a Linux command based on your input.
Cancel
```

Parameters:
- -e or --explanation will explain the command for you
- -l or --legacy will use the GPT3.5 AI model instead of GPT4 (in case you don't have API access to GPT4
- -v or --version will show you the current version
- -h or --help will show the help message
### Parameters
- `-e` or `--explanation` will explain the command for you
- `-l` or `--legacy` will use the GPT3.5 AI model instead of GPT4 (in case you don't have API access to GPT4)
- `-h` or `--help` will show the help message
- `-h` or `--help` will show the help message

## Installation

Expand Down Expand Up @@ -69,8 +69,8 @@ chmod +x /usr/local/bin/please
You need an OpenAI API key. You can get one here: https://beta.openai.com/

The API key needs to be set:
- either via an ENV variable OPENAI_API_KEY
- via a keychain entry OPENAI_API_KEY (MacOS keychain and secret-tool on Linux are supported)
- either via an environment variable `OPENAI_API_KEY`
- via a keychain entry `OPENAI_API_KEY` (MacOS keychain and secret-tool on Linux are supported)

To set the API key via an environment variable, run

Expand Down

0 comments on commit 7741d75

Please sign in to comment.