yetone / avante.nvim

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! 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 • **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 ( 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. Avante Zen Mode Due to the prevalence of claude code, it is clear that this is an era of Coding Agent CLIs. As a result, there are many arguments like: in the Vibe Coding era, editors are no longer needed; you only need to use the CLI in the terminal. But have people realized that for more than half a century, Terminal-based Editors have solved and standardized the biggest problem with Terminal-based applications — that is, the awkward TUI interactions! No matter how much these Coding Agent CLIs optimize their UI/UX, their UI/UX will always be a subset of Terminal-based Editors (Vim, Emacs)! They cannot achieve Vim’s elegant action + text objects abstraction (imagine how you usually edit large multi-line prompts in an Agent CLI), nor can they leverage thousands of mature Vim/Neovim plugins to help optimize TUI UI/UX—such as easymotions and so on. Moreover, when they want to view or modify code, they often have to jump into other applications which forcibly interrupts the UI/UX experience. Therefore, Avante’s Zen Mode was born! It looks like a Vibe Coding Agent CLI but it is completely Neovim underneath. So you can use your muscle-memory Vim operations and those rich and mature Neovim plugins on it. At the same time, by leveraging ACP it has all capabilities of claude code / gemini-cli / codex! Why not enjoy both? Now all you need to do is alias this command to avante; 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 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: Your mission clearly describe what the ai should focus on and how it should help: Additional sections to consider • **project context**: brief description of the project, its goals, and target users • **technology stack**: list of technologies, frameworks, and tools used • **coding standards**: specific conventions, style guides, and patterns to follow • **architecture guidelines**: how components should interact and be organized • **testing requirements**: testing strategies and coverage expectations • **security considerations**: specific security requirements or constraints example avante.md Installation For building binary if you wish to build from source, then is required. Otherwise and will be used to get prebuilt binary from GitHub. lazy.nvim (recommended) vim-plug mini.deps Packer Home Manager Nixvim Lua > [!IMPORTANT] > > is currently only compatible with Neovim 0.10.1 or later. Please ensure that your Neovim version meets these requirements before proceeding. > [!NOTE] > > When loading the plugin synchronously, we recommend ing it sometime after your colorscheme. > [!NOTE] > > Recommended **Neovim** options: > > > [!TIP] > > Any rendering plugins that support markdown should work with Avante as long as you add the supported filetype . See and this comment for more information. Default setup configuration _See config.lua#L9 for the full config_ Default configuration copilot suggestion.debounce fortune` installed) next_prompt = { normal = " ", -- load the next (newer) prompt log in normal mode insert = " ", }, prev_prompt = { normal = " ", -- load the previous (older) prompt log in normal mode insert = " ", }, }, mappings = { --- @class AvanteConflictMappings diff = { ours = "co", theirs = "ct", all_theirs = "ca", both = "cb", cursor = "cc", next = "]x", prev = "[x", }, suggestion = { accept = " ", next = " ", prev = " ", dismiss = " ", }, jump = { next = "]]", prev = "[[", }, submit = { _...truncated for preview_