Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ncoop57 authored Dec 5, 2024
1 parent fdb710a commit 423b0fe
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ We recommend also setting up your terminal editor of choice to keep the editor c
echo "set t_ti= t_te=" >> ~/.vimrc
```

You will also need to get an Anthropic API key and set its environment variable:

```sh
export ANTHROPIC_API_KEY=sk...
```

## How to use

`ShellSage` is designed to be ran inside a tmux session since it relies on tmux for getting what has is displayed on your terminal as context. If you don't want to use tmux, you will need to use the `--NH` command, which will not include your terminal history.
Expand Down

0 comments on commit 423b0fe

Please sign in to comment.