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

feat: Improve README.md

Browse Source
This commit is contained in:
Myzel394 2024-03-23 18:52:57 +01:00
parent 0bb4db254b
commit c8a4db2e5b
No known key found for this signature in database
GPG Key ID: DEC4AAB876F73185
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,14 +1,31 @@
# zsh-copilot
How we all expected GitHub Copilot in the CLI to be.
Get suggestions **truly** in your shell. No `suggest` bullshit. Just press `CTRL + Z` and get your suggestion.
## Installation
### Dependencies
Please make sure you have the following dependencies installed:
* [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)
```sh
git clone https://github.com/Myzel394/zsh-copilot.git ~/.zsh-copilot
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:
```sh
export OPENAI_API_KEY=<your-api-key>
```
I tried out using `gpt-3` but the results were garbage.
## Usage
Type in your command or your message and press `CTRL + Z` to get your suggestion!