mirror of
https://github.com/Myzel394/zsh-copilot.git
synced 2025-06-18 20:55:26 +02:00
feat: Add instructions for oh my zsh
This commit is contained in:
parent
0bc635926b
commit
75e47a9beb
25
README.md
25
README.md
@ -15,12 +15,31 @@ Please make sure you have the following dependencies installed:
|
|||||||
* [jq](https://github.com/jqlang/jq)
|
* [jq](https://github.com/jqlang/jq)
|
||||||
* [curl](https://github.com/curl/curl)
|
* [curl](https://github.com/curl/curl)
|
||||||
|
|
||||||
|
### Oh My Zsh
|
||||||
|
|
||||||
|
1. Clone `zsh-copilot` into $ZSH_CUSTOM/plugins (by default ~/.oh-my-zsh/custom/plugins)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/Myzel394/zsh-copilot.git ~/.zsh-copilot
|
git clone https://git.myzel394.app/Myzel394/zsh-copilot ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
|
||||||
echo "source ~/.zsh-copilot/zsh-copilot.plugin.zsh" >> ~/.zshrc
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration
|
2. Add `zsh-copilot` to the plugins array in your `.zshrc` file:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
plugins=(
|
||||||
|
# your other plugins...
|
||||||
|
zsh-autosuggestions
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Manual Installation
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://git.myzel394.app/Myzel394/zsh-copilot ~/.config/zsh-copilot
|
||||||
|
echo "source ~/.config/zsh-copilot/zsh-copilot.plugin.zsh" >> ~/.zshrc
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
You need to have an API key for either OpenAI or Anthropic to use this plugin. Expose this via the appropriate 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:
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user