README.md

zsh-github-copilot

A zsh plugin for GitHub Copilot

✔️ Setup

Requires the GitHub CLI with the Copilot extension installed and configured.

The plugin will check for the extension and other dependencies at source time, to disable this check, set the ZSH_GH_COPILOT_NO_CHECK environment variable to 1.

🚀 Installation

antigen

Add the following to your .zshrc:

antigen bundle loiccoyle/zsh-github-copilot

oh-my-zsh

Clone this repository into $ZSH_CUSTOM/plugins (by default ~/.oh-my-zsh/custom/plugins):

git clone https://github.com/loiccoyle/zsh-github-copilot ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-github-copilot

Add the plugin to the list of plugins for Oh My Zsh to load (inside ~/.zshrc):

plugins=(
    # other plugins...
    zsh-github-copilot
)

zinit

Add the following to your .zshrc:

zinit light loiccoyle/zsh-github-copilot

zplug

Add the following to your .zshrc:

zplug "loiccoyle/zsh-github-copilot"

zpm

Add the following to your .zshrc:

zpm load loiccoyle/zsh-github-copilot

🧠Usage

Bind the suggest and/or explain widgets:

For Linux/Windows

bindkey '^[|' zsh_gh_copilot_explain  # bind Alt+shift+\ to explain
bindkey '^[\' zsh_gh_copilot_suggest  # bind Alt+\ to suggest

For Mac

bindkey '»' zsh_gh_copilot_explain  # bind Option+shift+\ to explain
bindkey '«' zsh_gh_copilot_suggest  # bind Option+\ to suggest

Explanations

To get command explanations, write out the command in your prompt and hit your keybind.

Suggestions

To get Copilot to suggest a command to fulfill a query, type out the query in your prompt and hit your suggest keybind.

🤩 Credit

This plugin draws from stefanheule/zsh-llm-suggestions