How to install CopilotChat.nvim with lazy.nvim?

Use the provided Lua snippet in the README, ensuring plenary.nvim is a dependency and the build command is set, then configure options like model and window layout in the opts table.

CopilotChat.nvim vs using GitHub Copilot in VSCode?

CopilotChat.nvim brings similar chat functionality to Neovim with more privacy control and customization via Lua API, but requires manual setup and lacks the native integration of VSCode's Copilot extension.

Can I use local AI models like Ollama with CopilotChat.nvim?

Yes, it supports custom providers such as Ollama and Mistral.ai, but you need to configure them in the providers section of the setup, as outlined in the README's configuration examples.

How to create custom prompts in CopilotChat.nvim?

Define prompts in the configuration with system prompts and mappings, similar to the examples in the Prompts section, allowing for reusable templates like /Explain or /Review.

Why is autocompletion not working in CopilotChat.nvim?

Check your completeopt settings; the README warns that for Neovim < 0.11.0, you must add noinsert or noselect, and disable conflicts with other plugins like copilot.vim using vim.g.copilot_no_tab_map.

Is CopilotChat.nvim free to use?

The plugin is open-source, but using GitHub Copilot models requires a paid subscription, though you can integrate free custom providers like Ollama for local model usage.

How to save and load chat history in CopilotChat.nvim?

Use commands like :CopilotChatSave and :CopilotChatLoad from the Commands table, or via the Lua API with chat.save() and chat.load() for automated workflows.

CopilotChat.nvim — GitHub Copilot Chat for Neovim

Q: Is CopilotChat.nvim free to use?

The plugin is open-source, but using GitHub Copilot models requires a paid subscription, though you can integrate free custom providers like Ollama for local model usage.

Q: How to save and load chat history in CopilotChat.nvim?

Use commands like :CopilotChatSave and :CopilotChatLoad from the Commands table, or via the Lua API with chat.save() and chat.load() for automated workflows.

What is CopilotChat.nvim?

CopilotChat.nvim is a Neovim plugin that integrates GitHub Copilot Chat functionality directly into the editor, enabling developers to interact with AI assistants without leaving their workflow. It provides a native chat interface with access to multiple AI models and workspace-aware tools for enhanced coding assistance, focusing on transparency and user control over data sharing.

Target Audience

Neovim users who are already subscribed to GitHub Copilot and want to access its chat features within their editor, particularly developers who prioritize privacy and want granular control over what data is shared with AI models.

Value Proposition

Developers choose CopilotChat.nvim because it offers a privacy-first, fully integrated chat experience within Neovim with support for multiple AI models (including GitHub Copilot's models and custom providers like Ollama), tool calling for workspace operations, and extensive customization through a comprehensive Lua API.

Chat with GitHub Copilot in Neovim

Use Cases

Best For

Neovim users who want to use GitHub Copilot Chat without switching to a separate IDE or web interface.
Developers who need AI-assisted code review, explanation, or optimization directly within their editor using predefined prompts like /Review, /Explain, and /Optimize.
Privacy-conscious users who require explicit approval before AI models can access workspace data through tool calls.
Teams or individuals building custom AI workflows in Neovim through the plugin's extensible Lua API and support for custom functions and providers.
Managing token usage efficiently during AI-assisted coding sessions with features like resource replacement and history management via tiktoken.
Integrating AI-powered code generation, documentation, and testing into existing Neovim configurations with commands and key mappings.

Not Ideal For

Developers not subscribed to GitHub Copilot, as core functionality requires an active Copilot subscription and access to its API.
Users of IDEs other than Neovim, since the plugin is tightly integrated with Neovim's Lua ecosystem and specific version requirements (0.10.0+).
Teams seeking a plug-and-play AI assistant with zero configuration, due to the need for dependency management (e.g., curl, plenary.nvim) and optional picker integrations.
Projects on tight budgets needing consistently free AI models, because while custom providers are supported, the primary integration is with paid GitHub Copilot services.

Pros & Cons

Pros

Multiple Model Support

Supports GitHub Copilot models (GPT-4o, Claude, etc.) plus custom providers like Ollama and Mistral.ai, offering flexibility as detailed in the Key Features section.

Privacy-First Design

Ensures explicit user approval for tool calls and no background data collection, aligning with the philosophy of transparency and control over shared data.

Workspace-Aware Tools

Allows LLMs to call functions for file reading, git operations, and search with user approval, enhancing coding assistance directly within the editor via predefined resources and tools.

Token Efficiency

Uses resource replacement and tiktoken for history management to prevent duplicate context, optimizing token usage as emphasized in the README's features.

Cons

Complex Setup and Dependencies

Requires Neovim 0.10.0+, curl, plenary.nvim, and optional tools like tiktoken_core, with potential key mapping conflicts noted in WARNING sections for plugins like copilot.vim.

Dependency on GitHub Copilot

Primary functionality hinges on a GitHub Copilot subscription, limiting accessibility for users without access or those preferring fully open-source or free AI models.

Limited Out-of-the-Box Integration

Requires manual configuration for picker integrations (e.g., fzf-lua, telescope) and custom highlights, lacking seamless setup compared to AI features in full IDEs like VSCode.

Frequently Asked Questions

What is CopilotChat.nvim?

Target Audience

Value Proposition

Use Cases

Best For

Neovim users who want to use GitHub Copilot Chat without switching to a separate IDE or web interface.
Developers who need AI-assisted code review, explanation, or optimization directly within their editor using predefined prompts like /Review, /Explain, and /Optimize.
Privacy-conscious users who require explicit approval before AI models can access workspace data through tool calls.
Teams or individuals building custom AI workflows in Neovim through the plugin's extensible Lua API and support for custom functions and providers.
Managing token usage efficiently during AI-assisted coding sessions with features like resource replacement and history management via tiktoken.
Integrating AI-powered code generation, documentation, and testing into existing Neovim configurations with commands and key mappings.

Not Ideal For

Developers not subscribed to GitHub Copilot, as core functionality requires an active Copilot subscription and access to its API.
Users of IDEs other than Neovim, since the plugin is tightly integrated with Neovim's Lua ecosystem and specific version requirements (0.10.0+).
Teams seeking a plug-and-play AI assistant with zero configuration, due to the need for dependency management (e.g., curl, plenary.nvim) and optional picker integrations.
Projects on tight budgets needing consistently free AI models, because while custom providers are supported, the primary integration is with paid GitHub Copilot services.

Pros & Cons

Pros

Multiple Model Support

Supports GitHub Copilot models (GPT-4o, Claude, etc.) plus custom providers like Ollama and Mistral.ai, offering flexibility as detailed in the Key Features section.

Privacy-First Design

Ensures explicit user approval for tool calls and no background data collection, aligning with the philosophy of transparency and control over shared data.

Workspace-Aware Tools

Allows LLMs to call functions for file reading, git operations, and search with user approval, enhancing coding assistance directly within the editor via predefined resources and tools.

Token Efficiency

Uses resource replacement and tiktoken for history management to prevent duplicate context, optimizing token usage as emphasized in the README's features.

Cons

Complex Setup and Dependencies

Requires Neovim 0.10.0+, curl, plenary.nvim, and optional tools like tiktoken_core, with potential key mapping conflicts noted in WARNING sections for plugins like copilot.vim.

Dependency on GitHub Copilot

Primary functionality hinges on a GitHub Copilot subscription, limiting accessibility for users without access or those preferring fully open-source or free AI models.

Limited Out-of-the-Box Integration

Requires manual configuration for picker integrations (e.g., fzf-lua, telescope) and custom highlights, lacking seamless setup compared to AI features in full IDEs like VSCode.

Frequently Asked Questions

CopilotChat.nvim

What is CopilotChat.nvim?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

CopilotChat.nvim

What is CopilotChat.nvim?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?