Copilot Chat for Emacs

Description

This plugin allows you to chat with github copilot.

Feel free to contribute, report issues or discuss new features.

Installation

Melpa

Copilot-chat is available on melpa :

M-x package-install RET copilot-chat RET

With use-package :

(use-package copilot-chat)

Straight

(use-package copilot-chat
  :straight (:host github :repo "chep/copilot-chat.el" :files ("*.el"))
  :after (request org markdown-mode shell-maker))

Manual

Clone repository and eval files in emacs.

Configuration

Github

You will need a github acccount with access to copilot API. When sending the first prompt, you will need to authenticate to github. Follow instructions and everything will be fine.

Backend

copilot-chat-backend can be set to 'curl (default) or 'request.

With curl, answers will be written token by token. Curl path can be set with copilot-chat-curl-program variable.
With request library, the text is written when all data is read and this can be long.

Frontend

Several frontends are available. You can select your favorite one by setting the copilot-chat-frontend variable to 'markdown, 'org or 'shell-maker ( https://github.com/xenodium/chatgpt-shell ).

Try them and choose wisely.

Magit commits

You can use copilot to generate your commit messages :

(add-hook 'git-commit-setup-hook 'copilot-chat-insert-commit-message)

Or call manually (copilot-chat-insert-commit-message) when in the commit message buffer.

Proxy

The proxy can be configured with the curl backend. For the emacs-request backend, please refer to the emacs-request documentation if you need to configure a proxy.

Use the variables copilot-chat-curl-proxy, copilot-chat-curl-proxy-user-pass, and copilot-chat-curl-proxy-insecure to set up a proxy. Refer to the documentation for each variable to learn how to use them.

Proxies have not been thoroughly tested yet, so there may be bugs. Many options are missing for HTTPS proxies. Please open an issue if you need additional features.

Usage

Basic

Start chatting with copilot-chat-display. Type your question in *copilot-chat-prompt* buffer, then press C-c C-c or C-c RET.
You may need to authenticate to github. Follow instructions.

You can select buffers that will be added as context in your prompt. Use copilot-chat-add-current-buffer and copilot-chat-del-current-buffer. You can also manage buffers by using copilot-chat-list.
Selected buffers will be sent with each prompt until you remove them.

Functions

(copilot-chat-reset) reset everything including history, buffers and frontend.
(copilot-chat-display) display copilot chat buffers.
(copilot-chat-explain-symbol-at-line) ask Copilot to explain symbol under point.
(copilot-chat-explain) ask copilot to explain selected code.
(copilot-chat-review) ask copilot to review selected code.
(copilot-chat-doc) ask copilot to document selected code.
(copilot-chat-fix) ask copilot to fix selected code.
(copilot-chat-optimize) ask copilot to optimize selected code.
(copilot-chat-test) ask copilot to write tests for selected code.
(copilot-chat-custom-prompt-selection) ask for a prompt in minibuffer and pastes selection after it before sending it to copilot.
(copilot-chat-explain-defun) ask copilot to explain current function under point.
(copilot-chat-custom-prompt-function) ask copilot to apply a custom prompt to the function body under point. Eg. instruct on how to refactor the function.
(copilot-chat-review-whole-buffer) ask copilot to review the current whole buffer. It can be used to review the full class, or, review the magit diff for my change, or other people's change.
(copilot-chat-switch-to-buffer) switch to Copilot Chat buffer, side by side with the current code editing buffer.
(copilot-chat-add-current-buffer) add current buffer to copilot chat. Its content will be sent with every request.
(copilot-chat-del-current-buffer) remove current buffer.
(copilot-chat-list) open buffer list.
(copilot-chat-prompt-history-previous) insert previous prompt from history in prompt buffer.
(copilot-chat-prompt-history-next) insert next prompt from history in prompt buffer.
(copilot-chat-ask-and-insert) ask for a custom prompt and write answer in current buffer at point.
(copilot-chat-insert-commit-message) Insert in the current buffer a copilot generated commit message.
(copilot-chat-set-model) Select AI model to use.

Key bindings

Warning : key bindings have changed since Melpa integration needs to avoid C-c <letter> bindings.

Prompt buffer

C-c RET send prompt. Answer will be written in chat buffer.
M-p previous prompt.
M-n next prompt.
C-c C-l open buffer list.
C-c C-q bury buffer and delete window

Chat buffer

q bury buffer
SPC ask question from mini-buffer

Buffer list buffer

RET select or deselect buffer on point
space select or deselect buffer on point
C-c C-c clear buffer list
g refresh list
q bury buffer and delete window

Notes

This plugin is unofficial and based on Copilot Chat for neovim repository: https://github.com/CopilotC-Nvim/CopilotChat.nvim

The prompt for git commit messages comes from gpt-commit.

For github copilot code completion in emacs, checkout copilot.el

tninja/copilot-chat.el