Skip to main content

​
Prerequisites

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

​
Build Dependencies

For building the binary:
  • cargo - Required if you wish to build from source
  • curl and tar - Used to get prebuilt binary from GitHub (if not building from source)

​
Installation Methods

Choose your preferred package manager below: 
{
  "yetone/avante.nvim",
  -- if you want to build from source then do `make BUILD_FROM_SOURCE=true`
  -- ⚠️ must add this setting! ! !
  build = vim.fn.has("win32") ~= 0
      and "powershell -ExecutionPolicy Bypass -File Build.ps1 -BuildFromSource false"
      or "make",
  event = "VeryLazy",
  version = false, -- Never set this value to "*"! Never!
  ---@module 'avante'
  ---@type avante.Config
  opts = {
    -- add any opts here
    -- this file can contain specific instructions for your project
    instructions_file = "avante.md",
    -- for example
    provider = "claude",
    providers = {
      claude = {
        endpoint = "https://api.anthropic.com",
        model = "claude-sonnet-4-20250514",
        timeout = 30000, -- Timeout in milliseconds
          extra_request_body = {
            temperature = 0.75,
            max_tokens = 20480,
          },
      },
    },
  },
  dependencies = {
    "nvim-lua/plenary.nvim",
    "MunifTanjim/nui.nvim",
    --- The below dependencies are optional,
    "nvim-mini/mini.pick", -- for file_selector provider mini.pick
    "nvim-telescope/telescope.nvim", -- for file_selector provider telescope
    "hrsh7th/nvim-cmp", -- autocompletion for avante commands and mentions
    "ibhagwan/fzf-lua", -- for file_selector provider fzf
    "stevearc/dressing.nvim", -- for input provider dressing
    "folke/snacks.nvim", -- for input provider snacks
    "nvim-tree/nvim-web-devicons", -- or echasnovski/mini.icons
    "zbirenbaum/copilot.lua", -- for providers='copilot'
    {
      -- 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 set this up properly if you have lazy=true
      'MeanderingProgrammer/render-markdown.nvim',
      opts = {
        file_types = { "markdown", "Avante" },
      },
      ft = { "markdown", "Avante" },
    },
  },
}

​
Important Notes

When loading the plugin synchronously, we recommend requireing it sometime after your colorscheme.
Recommended Neovim options:
-- views can only be fully collapsed with the global statusline
vim.opt.laststatus = 3
Any rendering plugins that support markdown should work with Avante as long as you add the supported filetype Avante. See this GitHub issue for more information.

​
Build from Source

If you want to build from source with lazy.nvim, modify the build command: 
build = "make BUILD_FROM_SOURCE=true"
For vim-plug, you can pass source=true when installing.

​
Verify Installation

After installation, you can verify that Avante.nvim is properly installed by running: 
:checkhealth avante
This will check for any missing dependencies or configuration issues.

​
Next Steps

Now that you’ve installed Avante.nvim, head over to the Quickstart guide to configure your AI provider and make your first AI-assisted code edit!

Build docs developers (and LLMs) love

Get started for freeTalk to us