avante-corp /avante.nvim

Use your Neovim like using Cursor AI IDE!

★ 18,195⑂ 855👁 70⑃ 2,012● 1,188▤ 46
LuaApache-2.0Created 2024-08-14
Download: v0.5.0v0.5.0 ↓0.5.02026-10-31
+3
Daily
18,195
stars
855
forks
70
watchers
2,012
prs
1,188
issues
46
releases

README

avante.nvim



  
  
  
  
  


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!





 Table of contents

- Features
- Avante Zen Mode
- Project instructions
- Installation
- Usage
  - Key Bindings
  - Commands
- Highlight Groups
- Fast Apply
- ACP Support
- RAG Service
- Tools
  - Disable Tools
  - Web Search Engines
- Integrations
- FAQ
- Contributing
- License

 Sponsorship ❤️

If you like this project, please consider supporting me on Patreon, as it helps me to continue maintaining and improving it:

Sponsor me

 Features preview

- 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.
- Project-Specific Instruction Files: Customize AI behavior by adding a markdown file (avante.md by default) in the project root. This file is automatically referenced during workspace changes. You can also configure a custom file name for tailored project instructions.
- ACP support: Agent Client Protocol support (codex, gemini, ...)
- Many providers supported: openai, anthropic, mistral, deepseek, ollama,
  llama-cpp, ...
- RAG (optional): you can with some extra configuration run a local RAG

 Avante Zen Mode

It is possible to launch avante such that it looks like a typical Vibe Coding Agent CLI while being Neovim underneath. All you need to do is install ./contrib/avante in your PATH (or create the equivalent alias); then every time you simply type avante just like using claude code and enter Avante’s Zen Mode!

The effect is as follows:



 Project instructions with avante.md




The avante.md file allows you to provide project-specific context and instructions to the ai. this file should be placed in your project root and will be automatically referenced during all interactions with avante.


 Best practices for avante.md

to get the most out of your project instruction file, consider following this structure:

 Your role

define the ai's persona and expertise level for your project:

markdown
 your role

you are an expert senior software engineer specializing in [technology stack]. you have deep knowledge of [specific frameworks/tools] and understand best practices for [domain/industry]. you write clean, maintainable, and well-documented code. you prioritize code quality, performance, and security in all your recommendations.


 Your mission

clearly describe what the ai should focus on and how it should help:

markdown
 your mission

your primary goal is to help build and mainta

Top issues

Discussions

Latest release

v0.5.0 v0.5.0 2026-10-31
0.5.0 (2026-10-31)

This release starts 2 refactoring:
- move more of the backend code to rust libraries: this release moves ACP support from homemade lua code to a rust library relying on the official ACP SDK. The goal is to make the backend more robust/featureful while keeping the ability to hack advanced stuff with lua. There is no point in redeveloping the whole backend from scratch, with all the bugs it entails. This frees maintainer time to focus on the actual neovim integration. 0.6 will move the classical LLM API backend to rust as well. This means the rust libraries are likely to e

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON