Installation

Requirements

Warning

For Neovim < 0.11.0, addnoinsert ornoselect to yourcompleteopt otherwise chat autocompletion will not work.For best autocompletion experience, also addpopup to yourcompleteopt (even on Neovim 0.11.0+).

Optional Dependencies

Integration with pickers

lazy.nvim

return {  {"CopilotC-Nvim/CopilotChat.nvim",dependencies= {      {"nvim-lua/plenary.nvim",branch="master"},    },build="make tiktoken",opts= {-- See Configuration section for options    },  },}

vim-plug

callplug#begin()Plug'nvim-lua/plenary.nvim'Plug'CopilotC-Nvim/CopilotChat.nvim'callplug#end()lua << EOFrequire("CopilotChat").setup()EOF

Core Concepts

Examples

#Add specific file to context#file:src/main.lua#Give LLM access to workspace tools@copilot What files are in this project?#Sticky prompt that persists>#buffer:current>You are a helpful coding assistant

Usage

Commands

Chat Key Mappings

Warning

Some plugins (e.g.copilot.vim) may also map common keys like<Tab> in insert mode.
To avoid conflicts, disable Copilot's default<Tab> mapping with:

vim.g.copilot_no_tab_map=truevim.keymap.set('i','<S-Tab>','copilot#Accept("\\<S-Tab>")', {expr=true,replace_keycodes=false })

You can also customize CopilotChat keymaps in your config.

Predefined Functions

Predefined Prompts

Configuration

Quick Setup

{model='gpt-4.1',-- AI model to usetemperature=0.1,-- Lower = focused, higher = creativewindow= {layout='vertical',-- 'vertical', 'horizontal', 'float'width=0.5,-- 50% of screen width  },auto_insert_mode=true,-- Enter insert mode when opening}

Window & Appearance

{window= {layout='float',width=80,-- Fixed width in columnsheight=20,-- Fixed height in rowsborder='rounded',-- 'single', 'double', 'rounded', 'solid'title='🤖 AI Assistant',zindex=100,-- Ensure window stays on top  },headers= {user='👤 You',assistant='🤖 Copilot',tool='🔧 Tool',  },separator='━━',auto_fold=true,-- Automatically folds non-assistant messages}

Buffer Behavior

-- Auto-command to customize chat buffer behaviorvim.api.nvim_create_autocmd('BufEnter', {pattern='copilot-*',callback=function()vim.opt_local.relativenumber=falsevim.opt_local.number=falsevim.opt_local.conceallevel=0end,})

Highlights

-- In your colorscheme or init.luavim.api.nvim_set_hl(0,'CopilotChatHeader', {fg='#7C3AED',bold=true })vim.api.nvim_set_hl(0,'CopilotChatSeparator', {fg='#374151'})

Prompts

{prompts= {MyCustomPrompt= {prompt='Explain how it works.',system_prompt='You are very good at explaining stuff',mapping='<leader>ccmc',description='My custom prompt description',    },Yarrr= {system_prompt='You are fascinated by pirates, so please respond in pirate speak.',    },NiceInstructions= {system_prompt='You are a nice coding tutor, so please respond in a friendly and helpful manner.',    }  }}

Functions

{functions= {birthday= {description="Retrieves birthday information for a person",uri="birthday://{name}",schema= {type='object',required= {'name'},properties= {name= {type='string',enum= {'Alice','Bob','Charlie'},description="Person's name",          },        },      },resolve=function(input)return {          {uri='birthday://'..input.name,mimetype='text/plain',data=input.name..' birthday info',          }        }end    }  }}

Providers

{providers= {my_provider= {get_url=function(opts)return"https://api.example.com/chat"end,get_headers=function()return { ["Authorization"]="Bearer"..api_key }end,get_models=function()return { {id="gpt-4.1",name="GPT-4.1 model"} }end,prepare_input=require('CopilotChat.config.providers').copilot.prepare_input,prepare_output=require('CopilotChat.config.providers').copilot.prepare_output,    }  }}

{-- Optional: Disable providerdisabled?:boolean,-- Optional: Extra info about the provider displayed in info panelget_info?():string[]-- Optional: Get extra request headers with optional expiration timeget_headers?():table<string,string>,number?,-- Optional: Get API endpoint URLget_url?(opts:CopilotChat.Provider.options):string,-- Optional: Prepare request inputprepare_input?(inputs:table<CopilotChat.Provider.input>,opts:CopilotChat.Provider.options):table,-- Optional: Prepare response outputprepare_output?(output:table,opts:CopilotChat.Provider.options):CopilotChat.Provider.output,-- Optional: Get available modelsget_models?(headers:table):table<CopilotChat.Provider.model>,}

API Reference

Core

localchat=require("CopilotChat")-- Basic Chat Functionschat.ask(prompt,config)-- Ask a question with optional configchat.response()-- Get the last response textchat.resolve_prompt()-- Resolve prompt referenceschat.resolve_tools()-- Resolve tools that are available for automatic use by LLMchat.resolve_model()-- Resolve model from prompt (WARN: async, requires plenary.async.run)-- Window Managementchat.open(config)-- Open chat window with optional configchat.close()-- Close chat windowchat.toggle(config)-- Toggle chat window visibility with optional configchat.reset()-- Reset the chatchat.stop()-- Stop current output-- Source Managementchat.get_source()-- Get the current source buffer and windowchat.set_source(winnr)-- Set the source window-- Prompt & Model Managementchat.select_prompt(config)-- Open prompt selector with optional configchat.select_model()-- Open model selector-- History Managementchat.load(name,history_path)-- Load chat historychat.save(name,history_path)-- Save chat history-- Configurationchat.setup(config)-- Update configurationchat.log_level(level)-- Set log level (debug, info, etc.)

Chat Window

localwindow=require("CopilotChat").chat-- Chat UI Statewindow:visible()-- Check if chat window is visiblewindow:focused()-- Check if chat window is focused-- Message Managementwindow:get_message(role,cursor)-- Get chat message by role, either last or closest to cursorwindow:add_message({role,content },replace)-- Add or replace a message in chatwindow:remove_message(role,cursor)-- Remove chat message by role, either last or closest to cursorwindow:get_block(role,cursor)-- Get code block by role, either last or closest to cursorwindow:add_sticky(sticky)-- Add sticky prompt to chat message-- Content Managementwindow:append(text)-- Append text to chat windowwindow:clear()-- Clear chat window contentwindow:start()-- Start writing to chat windowwindow:finish()-- Finish writing to chat window-- Navigationwindow:follow()-- Move cursor to end of chat contentwindow:focus()-- Focus the chat window-- Advanced Featureswindow:overlay(opts)-- Show overlay with specified options

Example Usage

-- Open chat, ask a question and handle responserequire("CopilotChat").open()require("CopilotChat").ask("#buffer Explain this code", {callback=function(response)vim.notify("Got response:"..response:sub(1,50).."...")returnresponseend,})-- Save and load chat historyrequire("CopilotChat").save("my_debugging_session")require("CopilotChat").load("my_debugging_session")-- Use custom sticky and modelrequire("CopilotChat").ask("How can I optimize this?", {model="gpt-4.1",sticky= {"#buffer","#gitdiff:staged"}})

Development

Setup

git clone https://github.com/CopilotC-Nvim/CopilotChat.nvimcd CopilotChat.nvim

make install-pre-commit

maketest

Contributing

Contributors

Stargazers