Myzel394/zsh-copilot
1
0
Fork 0
mirror of https://github.com/Myzel394/zsh-copilot.git synced 2025-06-18 20:55:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update README.md with new AI provider configuration

Browse Source
This commit is contained in:
dahromy (aider) 2024-09-16 17:24:42 +03:00
parent 321f58d71f
commit ee547607ec
1 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -22,18 +22,34 @@ echo "source ~/.zsh-copilot/zsh-copilot.plugin.zsh" >> ~/.zshrc
### Configuration
You need to have an OPENAI API key with access to `gpt-4` to use this plugin. Expose this via the `OPENAI_API_KEY` environment variable:
You need to have an API key for either OpenAI or Anthropic to use this plugin. Expose this via the appropriate environment variable:
For OpenAI (default):
```sh
export OPENAI_API_KEY=<your-api-key>
export OPENAI_API_KEY=<your-openai-api-key>
```
I tried out using `gpt-3` but the results were garbage.
For Anthropic:
```sh
export ANTHROPIC_API_KEY=<your-anthropic-api-key>
```
To see available configurations, run:
You can configure the AI provider using the `ZSH_COPILOT_AI_PROVIDER` variable:
```sh
zsh-copilot --help
export ZSH_COPILOT_AI_PROVIDER="openai" # or "anthropic"
```
Other configuration options:
- `ZSH_COPILOT_KEY`: Key to press to get suggestions (default: ^z)
- `ZSH_COPILOT_SEND_CONTEXT`: If `true`, zsh-copilot will send context information to the AI model (default: true)
- `ZSH_COPILOT_DEBUG`: Enable debug logging (default: false)
To see all available configurations and their current values, run:
```sh
zsh-copilot
```
## Usage