Skip to content

Commit

Permalink
Updated installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bakks committed Feb 23, 2023
1 parent 1bc5785 commit 3cb712b
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Let's do useful things with LLMs from the command line, with a bent towards soft

Solution:

- This is an experimental MacOS command line tool for using GPT-3. You give it your OpenAI key and it runs queries.
- This is an experimental MacOS/Linux command line tool for using GPT-3. You give it your OpenAI key and it runs queries.
- What can you do with it?
- Run raw GPT prompts.
- Semantically summarize local content.
Expand All @@ -32,23 +32,32 @@ Solution:

## Installation / Authentication

Butterfish works on MacOS and is installed via Homebrew:

```
Butterfish works on MacOS and Linux. You can install via Homebrew:

```bash
brew install bakks/bakks/butterfish
butterfish prompt "Is this thing working?"
```

You can also install with `go get`, which is recommended for Linux:

```bash
go get github.com/bakks/butterfish/cmd/butterfish
butterfish prompt "Is this thing working?"
```

This should prompt you to paste in an OpenAI API secret key. You can get an OpenAI key at [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
The first invocation will prompt you to paste in an OpenAI API secret key. You can get an OpenAI key at [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).

The key will be written to `~/.config/butterfish/butterfish.env`, which looks like:

```
OPENAI_TOKEN=sk-foobar
```

It may also be useful to alias the `butterfish` command to something shorter. If you add the following line to your `~/.zshrc` or `~/.bashrc` file then you can run it with only `bf`.

```
alias bf="butterfish"
```

## Examples
Expand Down Expand Up @@ -375,4 +384,4 @@ git clone https://github.com/bakks/butterfish
cd butterfish
make
./bin/butterfish prompt "Is this thing working?"
```
```

0 comments on commit 3cb712b

Please sign in to comment.