https://github.com/danbradbury/copilot-chat.vim
Copilot Chat for Vim
https://github.com/danbradbury/copilot-chat.vim
ai chatbot copilot vim workflow
Last synced: about 1 year ago
JSON representation
Copilot Chat for Vim
- Host: GitHub
- URL: https://github.com/danbradbury/copilot-chat.vim
- Owner: DanBradbury
- License: mit
- Created: 2025-03-15T08:21:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-21T06:38:41.000Z (about 1 year ago)
- Last Synced: 2025-04-24T00:58:52.643Z (about 1 year ago)
- Topics: ai, chatbot, copilot, vim, workflow
- Language: Vim Script
- Homepage:
- Size: 64.5 KB
- Stars: 35
- Watchers: 4
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Copilot Chat for Vim
[](https://github.com/DanBradbury/copilot-chat.vim/actions/workflows/lint.yml) [](https://github.com/DanBradbury/copilot-chat.vim/actions/workflows/test.yml)
Copilot Chat functionality without having to leave Vim.
Nvim folks will be able to use [CopilotChat.nvim](https://github.com/CopilotC-Nvim/CopilotChat.nvim) for a similar experience.
## Requirements
- [Vim](https://github.com/vim/vim)
- [NerdFonts](https://www.nerdfonts.com) (Optional for pretty icons)
## Installation
Using [Vundle](https://github.com/VundleVim/Vundle.vim), [Pathogen](https://github.com/tpope/vim-pathogen) [vim-plug](https://github.com/junegunn/vim-plug), Vim 8+ packages, or any other plugin manager.
### vundle
Add into `.vimrc` configuration.
```vim
call vundle#begin()
Plugin 'DanBradbury/copilot-chat.vim'
call vundle#end()
filetype plugin indent on
```
### Pathogen
Clone repository.
```bash
git clone https://github.com/DanBradbury/copilot-chat.vim.git ~/.vim/bundle
```
Add into `.vimrc` configuration.
```vim
call pathogen#infect()
syntax on
filetype plugin indent on
```
### vim-plug
Add into `.vimrc` configuration.
```vim
call plug#begin()
Plug 'DanBradbury/copilot-chat.vim'
call plug#end()
filetype plugin indent on
```
### Vim 8+ packages
Clone repository.
```bash
git clone https://github.com/DanBradbury/copilot-chat.vim.git ~/.vim/pack/plugins/start
```
Add into `.vimrc` configuration.
```vim
filetype plugin indent on
```
## Setup
1. Run `:CopilotChatOpen` to open a chat window. You will be prompted to setup your device on first use.
2. Write your prompt under the line separator and press `` in normal mode.
3. You should see a `Waiting for response..` in the buffer to indicate work is being done in the background.
4. 🎉🎉🎉
## Commands
| Command | Description |
| ------- | ----------- |
| `:CopilotChat ` | Launches a new Copilot chat with your input as the initial prompt |
| `:CopilotChatOpen` | Opens a new Copilot chat window (default vsplit right) |
| `:CopilotChatFocus` | Focuses the currently active chat window |
| `:CopilotChatReset` | Resets the current chat window |
| `:CopilotChatConfig` | Open `config.json` for default settings when opening a new CopilotChat window |
| `:CopilotChatModels` | View available modes / select active model |
| `:CopilotChatSave ?` | Save chat history (uses timestamp if no name provided) |
| `:CopilotChatLoad ?` | Load chat history (shows list of saved histories if no name provided) |
| `:CopilotChatList` | List all saved chat histories |
| `:CopilotChatSetActive ?` | Sets the active chat window to the buffer number provided (default is the current buffer) |
## Plugin Keys
| Key | Description |
| ------- | ----------- |
| `CopilotChatAddSelection` | Copies selected text into active char buffer |
## Default Key Mappings
| Location | Insert | Normal | Visual | Action |
| ---- | ---- | ---- | ---- | ---- |
| Chat window| - | `` | - | Submit current prompt |
| Models list | - | `` | - | Select the model on the current line for future chat use |
## User Key mappings
The plugin avoids adding any default vim key mappings to prevent conflict with
other plugins and the users' own mappings.
However, to easily work with the Copilot Chat plugin, the user might want to
setup his own vim key mappings. See example configuration below:
```vim
" Open a new Cpilot Chat window
nnoremap cc :CopilotChatOpen
" Add visual selection to copilot window
vmap a CopilotChatAddSelection
```
## Features
### Model Selection
`:CopilotChatModels` brings up a buffer for of all the available models for you to choose from. Simply press `` in normal mode on the model you would like to use. New chats will use the selected model.
### Add Selection to Chat
By default, this is configured to `a` when in visual mode.
- Adds the selection to the active chat window inside of a `&filetype` named codeblock
### Chat History
Save and restore your chat conversations with Copilot:
#### Saving Chat History
- Use `:CopilotChatSave ` to save the current chat history
- If no name is provided, a timestamp will be used automatically
- History files are stored in `~/.vim/copilot-chat/history/` as JSON files
#### Loading Chat History
- Use `:CopilotChatLoad ` to load a previously saved chat
- If no name is provided, a list of available chat histories will be shown
- You can also view all saved histories with `:CopilotChatList`
### Prompt Templates
Copilot Chat supports custom prompt templates that can be quickly accessed during chat sessions. Templates allow you to save frequently used prompts and invoke them with a simple syntax.
#### Using Prompts
- In the chat window, start a line with `> PROMPT_NAME`
- The `PROMPT_NAME` will be automatically replaced with the template content before sending to Copilot
- Example: `> explain` would expand to the full explanation template
#### Managing Prompts
1. Open the config with `:CopilotChatConfig`
2. Add prompts to the `prompts` object in `config.json`:
```json
{
"model": "gpt-4",
"prompts": {
"explain": "Explain how this code works in detail:",
"refactor": "Suggest improvements and refactoring for this code:",
"docs": "Generate documentation for this code:"
}
}
```
#### Example Usage
```
> explain
function validateUser() {
// code to validate
}
```
This will send the full template text + your code to Copilot.
## Contributing
Please see the [contribution guide](./CONTRIBUTING.md) for more information.