Skip to content

Commit

Permalink
Revision 4
Browse files Browse the repository at this point in the history
  • Loading branch information
djcopley committed Jan 2, 2024
1 parent 8ec5eaa commit 383d0f0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ ShellOracle is designed to be used as a ZSH Line Editor widget activated by the

The generated command will be inserted into your shell prompt after a brief processing period.

**Ollama**
### Ollama

Before using ShellOracle with Ollama, pull the model you want to use. The default model is `codellama:13b`. To pull the
default model, run:
Expand All @@ -83,19 +83,19 @@ default model, run:
ollama pull codellama:13b
```

**OpenAI**
### OpenAI

To use ShellOracle with the OpenAI provider, create an [API key](https://platform.openai.com/account/api-keys). Edit
your `~/.shelloracle/config.toml` to change your provider and enter your API key.

**Other ways to run ShellOracle**
### Other ways to run ShellOracle

ShellOracle can be run as a Python module with `python3 -m shelloracle` or using its entrypoint `shor`; however,
there are a few caveats with this method:
- Ensure your `~/.local/bin` directory is added to your PATH variable for the entrypoint to work.
- Running ShellOracle with this method will not automatically insert the result into your shell prompt.

**Tips**
### Tips

1. If you press CTRL+F with text in your ZLE buffer, all text left of your cursor will carry over to your ShellOracle
prompt.
Expand Down

0 comments on commit 383d0f0

Please sign in to comment.