avante.nvim is a Neovim plugin designed to emulate the behaviour of the Cursor AI IDE. It provides users with AI-driven code suggestions and the ability to apply these recommendations directly to their source files with minimal effort.
Note
🥰 This project is undergoing rapid iterations, and many exciting features will be added successively. Stay tuned!
avante-2.mp4
avante-3.mp4
- AI-Powered Code Assistance: Interact with AI to ask questions about your current code file and receive intelligent suggestions for improvement or modification.
- One-Click Application: Quickly apply the AI's suggested changes to your source code with a single command, streamlining the editing process and saving time.
Install avante.nvim using lazy.nvim:
{
"yetone/avante.nvim",
event = "VeryLazy",
opts = {
-- add any opts here
},
keys = { -- See https://github.com/yetone/avante.nvim/wiki#keymaps for more info
{ "<leader>aa", function() require("avante.api").ask() end, desc = "avante: ask", mode = { "n", "v" } },
{ "<leader>ar", function() require("avante.api").refresh() end, desc = "avante: refresh", mode = "v" },
{ "<leader>ae", function() require("avante.api").edit() end, desc = "avante: edit", mode = { "n", "v" } },
},
dependencies = {
"stevearc/dressing.nvim",
"nvim-lua/plenary.nvim",
"MunifTanjim/nui.nvim",
--- The below dependencies are optional,
"nvim-tree/nvim-web-devicons", -- or echasnovski/mini.icons
{
-- support for image pasting
"HakonHarnes/img-clip.nvim",
event = "VeryLazy",
opts = {
-- recommended settings
default = {
embed_image_as_base64 = false,
prompt_for_file_name = false,
drag_and_drop = {
insert_mode = true,
},
-- required for Windows users
use_absolute_path = true,
},
},
},
{
-- Make sure to setup it properly if you have lazy=true
'MeanderingProgrammer/render-markdown.nvim',
opts = {
file_types = { "markdown", "Avante" },
},
ft = { "markdown", "Avante" },
},
},
}Important
avante.nvim is currently only compatible with Neovim 0.10.0 or later. Please ensure that your Neovim version meets these requirements before proceeding.
Note
render-markdown.nvim is an optional dependency that is used to render the markdown content of the chat history. Make sure to also include Avante as a filetype
to its setup:
{
"MeanderingProgrammer/render-markdown.nvim",
opts = {
file_types = { "markdown", "Avante" },
},
ft = { "markdown", "Avante" },
}Default setup configuration:
See config.lua#L9 for the full config
{
---@alias Provider "openai" | "claude" | "azure" | "cohere" | [string]
provider = "claude", -- Only recommend using Claude
claude = {
endpoint = "https://api.anthropic.com",
model = "claude-3-5-sonnet-20240620",
temperature = 0,
max_tokens = 4096,
},
mappings = {
--- @class AvanteConflictMappings
diff = {
ours = "co",
theirs = "ct",
both = "cb",
next = "]x",
prev = "[x",
},
jump = {
next = "]]",
prev = "[[",
},
submit = {
normal = "<CR>",
insert = "<C-s>",
},
},
hints = { enabled = true },
windows = {
wrap = true, -- similar to vim.o.wrap
width = 30, -- default % based on available width
sidebar_header = {
align = "center", -- left, center, right for title
rounded = true,
},
},
highlights = {
---@type AvanteConflictHighlights
diff = {
current = "DiffText",
incoming = "DiffAdd",
},
},
--- @class AvanteConflictUserConfig
diff = {
debug = false,
autojump = true,
---@type string | fun(): any
list_opener = "copen",
},
}Given its early stage, avante.nvim currently supports the following basic functionalities:
Important
Avante will only support Claude, and OpenAI (and its variants including azure)out-of-the-box due to its high code quality generation. For all OpenAI-compatible providers, see wiki for more details.
Important
Due to the poor performance of other models, avante.nvim only recommends using the claude-3.5-sonnet model. All features can only be guaranteed to work properly on the claude-3.5-sonnet model. We do not accept changes to the code or prompts to accommodate other models. Otherwise, it will greatly increase our maintenance costs. We hope everyone can understand. Thank you!
Important
For most consistency between neovim session, it is recommended to set the environment variables in your shell file.
By default, Avante will prompt you at startup to input the API key for the provider you have selected.
For Claude:
export ANTHROPIC_API_KEY=your-api-keyFor OpenAI:
export OPENAI_API_KEY=your-api-keyFor Azure OpenAI:
export AZURE_OPENAI_API_KEY=your-api-key- Open a code file in Neovim.
- Use the
:AvanteAskcommand to query the AI about the code. - Review the AI's suggestions.
- Apply the recommended changes directly to your code with a simple command or key binding.
Note: The plugin is still under active development, and both its functionality and interface are subject to significant changes. Expect some rough edges and instability as the project evolves.
The following key bindings are available for use with avante.nvim:
| Key Binding | Description |
|---|---|
| Leaderaa | show sidebar |
| Leaderar | refresh sidebar |
| Leaderae | edit selected blocks |
| co | choose ours |
| ct | choose theirs |
| cb | choose both |
| c0 | choose none |
| ]x | move to previous conflict |
| [x | move to next conflict |
| [[ | jump to previous codeblocks (results window) |
| ]] | jump to next codeblocks (results windows) |
Note
If you are using lazy.nvim, then all keymap here will be safely set, meaning if <leader>aa is already binded, then avante.nvim won't bind this mapping.
In this case, user will be responsible for setting up their own. See notes on keymaps for more details.
| Highlight Group | Description | Notes |
|---|---|---|
| AvanteTitle | Title | |
| AvanteReversedTitle | Used for rounded border | |
| AvanteSubtitle | Selected code title | |
| AvanteReversedSubtitle | Used for rounded border | |
| AvanteThirdTitle | Prompt title | |
| AvanteReversedThirdTitle | Used for rounded border | |
| AvanteConflictCurrent | Current conflict highlight | Default to Config.highlights.diff.current |
| AvanteConflictIncoming | Incoming conflict highlight | Default to Config.highlights.diff.incoming |
| AvanteConflictCurrentLabel | Current conflict label highlight | Default to shade of AvanteConflictCurrent |
| AvanteConflictIncomingLabel | Incoming conflict label highlight | Default to shade of AvanteConflictIncoming |
See highlights.lua for more information
- Chat with current file
- Apply diff patch
- Chat with the selected block
- Slash commands
- Edit the selected block
- Smart Tab (Cursor Flow)
- Chat with project
- Chat with selected files
- Enhanced AI Interactions: Improve the depth of AI analysis and recommendations for more complex coding scenarios.
- LSP + Tree-sitter + LLM Integration: Integrate with LSP and Tree-sitter and LLM to provide more accurate and powerful code suggestions and analysis.
Contributions to avante.nvim are welcome! If you're interested in helping out, please feel free to submit pull requests or open issues. Before contributing, ensure that your code has been thoroughly tested.
See wiki for more recipes and tricks.
We would like to express our heartfelt gratitude to the contributors of the following open-source projects, whose code has provided invaluable inspiration and reference for the development of avante.nvim:
| Nvim Plugin | License | Functionality | Where did we use |
|---|---|---|---|
| git-conflict.nvim | No License | Diff comparison functionality | https://github.com/yetone/avante.nvim/blob/main/lua/avante/diff.lua |
| ChatGPT.nvim | Apache 2.0 License | Calculation of tokens count | https://github.com/yetone/avante.nvim/blob/main/lua/avante/utils/tokens.lua |
| img-clip.nvim | MIT License | Clipboard image support | https://github.com/yetone/avante.nvim/blob/main/lua/avante/clipboard.lua |
The high quality and ingenuity of these projects' source code have been immensely beneficial throughout our development process. We extend our sincere thanks and respect to the authors and contributors of these projects. It is the selfless dedication of the open-source community that drives projects like avante.nvim forward.
avante.nvim is licensed under the Apache 2.0 License. For more details, please refer to the LICENSE file.