Welcome to CodeCompanion.nvim

AI Coding, Vim Style

CodeCompanion is a plugin which enables you to code with AI, using LLMs and agents, in Neovim.

Features

:speech_balloon: Copilot Chat meets Zed AI, in Neovim
:zap: Integrates Neovim with LLMs and Agents in the CLI
:electric_plug: Support for LLMs from Anthropic, Copilot, GitHub Models, DeepSeek, Gemini, Mistral AI, Novita, Ollama, OpenAI, Azure OpenAI, HuggingFace and xAI out of the box (or bring your own!)
:robot: Support for Agent Client Protocol, enabling coding with agents like Augment Code, Cagent from Docker, Claude Code, Cline CLI, Codex, Copilot CLI, Gemini CLI, Goose, Cursor CLI, Kilo Code, Kimi CLI, Kiro, Mistral Vibe and OpenCode
:heart_hands: User contributed and supported adapters
:battery: Support for Model Context Protocol (MCP)
:rocket: Inline transformations, code creation and refactoring
:robot: Editor Context, Slash Commands, Tools and Workflows to improve LLM output
:brain: Support for rules files like CLAUDE.md, .cursor/rules and your own custom ones
:sparkles: Built-in prompt library for common tasks like advice on LSP errors and code explanations
:building_construction: Create your own custom prompts, Editor Context and Slash Commands
:books: Have multiple chats open at the same time
:art: Support for vision and images as input
:muscle: Async execution for fast performance

Overview

The plugin utilises objects called interactions. These are the different ways that a user can interact with the plugin. The chat interaction harnesses a buffer to allow direct conversation with the LLM. The inline interaction allows for output from the LLM to be written directly into a pre-existing Neovim buffer.

The plugin allows you to specify adapters for each interaction and also for each prompt library entry.

Supported LLMs and Agents

CodeCompanion uses HTTP and ACP adapters to connect to LLMs and agents. Out of the box, the plugin supports:

Anthropic (anthropic) - Requires an API key and supports prompt caching
Augment Code (auggie_cli) - Requires an API key
Cagent (cagent)
Claude Code (claude_code) - Requires an API key or a Claude Pro subscription
Cline CLI (cline_cli)
Codex (codex) - Requires an API key
Copilot (copilot) - Requires a token which is created via :Copilot setup in Copilot.vim
DeepSeek (deepseek) - Requires an API key
Gemini (gemini) - Requires an API key
Gemini CLI (gemini_cli) - Requires an API key or a Gemini Pro subscription
GitHub Models (githubmodels) - Requires gh to be installed and logged in
Goose (goose) - Requires an API key
HuggingFace (huggingface) - Requires an API key
Kilo Code (kilocode) - Requires an API key
Kimi CLI (kimi_cli) - Requires an API key
Mistral AI (mistral) - Requires an API key or a Le Chat Pro subscription
Novita (novita) - Requires an API key
Ollama (ollama) - Both local and remotely hosted
OpenAI (openai) - Requires an API key
opencode (opencode) - Requires an API key
xAI (xai) - Requires an API key

In order to add a custom adapter, please refer to the extending adapters documentation. Also, be sure to check out the community adapters section for user contributed adapters.