Take Your Neovim Editing to the Next Level with avante.nvim

Use your Neovim like using Cursor AI IDE! - GitHub

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! If you like this project, please consider supporting me on Patreon, as it helps me to continue maintaining and improving it: Sponsor me

Building Binary

For building binary if you wish to build from source, then cargo is required. Otherwise curl and tar will be used to get the prebuilt binary from GitHub.

Compatibility

avante.nvim is currently only compatible with Neovim 0.10.1 or later. Please ensure that your Neovim version meets these requirements before proceeding.

Loading Plugin Synchronously

When loading the plugin synchronously, we recommend requireing it sometime after your colorscheme.

Recommended Neovim Options

Tip: Any rendering plugins that support markdown should work with Avante as long as you add the supported filetype Avante. See #175 and this comment for more information.

See config.lua#L9 for the full config

Blink CMP Users

For blink cmp users (nvim-cmp alternative) view below instruction for configuration. This is achieved by emulating nvim-cmp using blink.compat or you can use Kaiser-Yang/blink-cmp-avante.

Customized Selector Provider

To create a customized selector provider, you can specify a customized function to launch a picker to select items and pass the selected items to the on_select callback.

Multiple Input Providers

Avante.nvim supports multiple input providers for user input (like API key entry). You can configure which provider to use:

For enhanced input UI with better styling and features: You'll need to install dressing.nvim
For modern, feature-rich input UI: You'll need to install snacks.nvim

To create a customized input provider, you can specify a function. Choose a selector other than native, as the default currently has an issue.

Key Functionality

Given its early stage, avante.nvim currently supports the following basic functionalities:

3 Package structure and state – R Packages (2e)

Supported Providers

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.

Claude-3.5-Sonnet Model

Since avante.nvim now supports cursor planning mode, the above statement is no longer valid! Avante.nvim now supports most models! If you encounter issues with normal usage, please try enabling cursor planning mode.

Environment Variables

For most consistency between Neovim sessions, 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.

Plugin Development

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.