🚀 Copilot CLI

Copilot CLI is a command-line interface for interacting with GitHub Copilot's chat functionality. This tool allows users to send prompts to Copilot, specify models, and perform predefined actions.

Features

• Send custom prompts to GitHub Copilot.
• Specify different models for chat completion.
• Use system prompts to guide the conversation.
• Perform predefined actions with customizable commands.
• Output responses to stdout or handle them with custom callbacks.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/copilot-cli.git
   cd copilot-cli

2. Install the required dependencies:

   pip install -r requirements.txt

3. You need need to already be connected to GitHub Copilot by VsCode, Neovim or any other IDE that supports Copilot.

Usage

To use the Copilot CLI, run the copilot-cli.py script with the desired arguments:

python copilot-cli.py --prompt "Your prompt here" --model "gpt-4o"

Arguments

• --path: Path to run the action in (default: .).
• --prompt: Prompt to send to Copilot Chat.
• --model: Model to use for the chat (default: gpt-4).
• --system_prompt: System prompt to send to Copilot Chat.
• --action: Action to perform (choices are defined in ActionManager).

Example

python copilot-cli.py --prompt "Explain the concept of recursion"

Actions

python copilot-cli.py --action "gitignore" --prompt "Write a gitignore for Python" --path "/path/to/project"

Extras

Adding copilot-cli to LazyGit

In ~/.config/lazygit/config.yml add the following snippets:

customCommands:
  - key: "<c-a>" # ctrl + a
    description: "Generate commit message"
    context: "files"
    loadingText: "Generating commit message..."
    subprocess: true
    prompts:
      - type: "menuFromCommand"
        title: "Copilot AI Convention Commit"
        key: "Msg"
        command: copilot-cli --action "lazygit-conventional-commit" --path "."
        filter: '^(?P<number>\d+):\s(?P<type>\w+)(?:\((?P<scope>[^)]+)\))?:\s(?P<message>.+)$'
        valueFormat: "{{ .type }}{{ if .scope }}({{ .scope }}){{ end }}: {{ .message }}"
        labelFormat: "{{ .type | red }}{{ if .scope }}({{ .scope }}){{ end }}: {{ .message | green }}"
      - type: "menu"
        key: "Confirm"
        title: "Confirm/Edit commit message"
        options:
          - name: "Commit"
            value: "commit"
          - name: "Edit"
            value: "edit"
    command: >
      {{- if eq .Form.Confirm "commit" -}}
        git commit -m '{{.Form.Msg}}'
      {{- else if eq .Form.Confirm "edit" -}}
        git commit -e -m '{{.Form.Msg}}'
      {{- else -}}
        echo "Commit cancelled" && exit 0
      {{- end -}}

It will enable generations of commits messages for staged changed when you press <CTRL-A>.

Acknowledgements

• GitHub Copilot
• OpenAI GPT-4