open-cli-copilot

Copilot-like autosuggestions generation for zsh.

Extends the zsh-autosuggestions plugin by adding an LLM-based autosuggestion strategy and natural language command generation within the terminal.

demo.mp4

Installation

1. Clone project repository to the location of choice:

   git clone https://github.com/OskarSzafer/open-cli-copilot.git

2. Inside the project repository create python venv and install requirements:

   python -m venv venv && ./venv/bin/pip install -r requirements.txt

3. Source main script, and export API-key by adding to ~/.zshrc following lines:

   export GOOGLE_API_KEY=<your_token>
   source ~/path/to/open-cli-copilot/copilot.zsh

   You can get your API-key from: https://aistudio.google.com/app/apikey

4. Start a new terminal session.

Requirements

• Zsh>=4.3.11
• Zsh-autosuggestions>=0.7.0
• Python>=3.9

Roadmap

• Improve handling of special characters in buffer
• Resolve conflicts with the zsh history widget
• Integrate with open-source LLMs using Hugging Face Transformers