Skip to content

Home

Jump to bottom
yetone edited this page Nov 16, 2024 · 47 revisions

Welcome to the avante.nvim wiki!

package managers.

we will only fully support lazy.nvim. Every other package manager are best-efforts. If you want to use anything else, please submit PR on how to make those better, thanks.

secrets.

A more secure way to set API key is through secret manager. You can do that by prefixing api_key_name like so:

{
  "yetone/avante.nvim",
  opts = {
    provider = "claude",
    claude = {
      api_key_name = "cmd:bw get notes anthropic-api-key", -- the shell command must prefixed with `^cmd:(.*)`
      -- api_key_name = {"bw","get","notes","anthropic-api-key"}, -- if it is a table of string, then default to command.
    }
  }
}

slash commands

In the input box, we have support a few slash commands. Try /help for more information.

error when sending request to LLM?

Make sure that you have credits in your accounts 😃

copilot?

set provider="copilot".

pass in additional generation parameters.

You can just add any accepted body fields to curl for given LLM provider:

opts = {
  gemini = { -- see https://ai.google.dev/api/generate-content#request-body_1
    generationConfig = {
      stopSequences = {"test"},
    }
  }
}

development.

To set up the development environment:

  1. Install StyLua for Lua code formatting.
  2. Install pre-commit for managing and maintaining pre-commit hooks.
  3. After cloning the repository, run the following command to set up pre-commit hooks:
pre-commit install --install-hooks

For setting up lua_ls you can use the following for nvim-lspconfig:

lua_ls = {
  settings = {
    Lua = {
      runtime = {
        version = "LuaJIT",
        special = { reload = "require" },
      },
      workspace = {
        library = {
          vim.fn.expand "$VIMRUNTIME/lua",
          vim.fn.expand "$VIMRUNTIME/lua/vim/lsp",
          vim.fn.stdpath "data" .. "/lazy/lazy.nvim/lua/lazy",
        },
      },
    },
  },
},

You can also use the following config for lazydev.nvim:

      {
        "folke/lazydev.nvim",
        ft = "lua",
        cmd = "LazyDev",
        opts = {
          dependencies = {
            -- Manage libuv types with lazy. Plugin will never be loaded
            { "Bilal2453/luvit-meta", lazy = true },
          },
          library = {
            { path = "~/workspace/avante.nvim/lua", words = { "avante" } },
            { path = "luvit-meta/library", words = { "vim%.uv" } },
          },
        },
      },

Then you can set dev = true in your lazy config for development.

keymaps and API, i guess.

Since #346, we will expose certain functions that are considered "public" API through avante.api.

Additionally, we will safely add certain keymaps if users yet to set those (only applies for lazy.nvim users) for core functionality, including AvanteAsk, AvanteEdit, and AvanteRefresh

Important

This means Leaderaa won't be set to AvanteAsk if you already set this mapping.

The following <Plug> will also be available for compatibility sake:

  • <Plug>(AvanteAsk)
  • <Plug>(AvanteEdit)
  • <Plug>(AvanteRefresh)

Example settings for keys settings in lazy.nvim:

    keys = function(_, keys)
      ---@type avante.Config
      local opts =
        require("lazy.core.plugin").values(require("lazy.core.config").spec.plugins["avante.nvim"], "opts", false)

      local mappings = {
        {
          opts.mappings.ask,
          function() require("avante.api").ask() end,
          desc = "avante: ask",
          mode = { "n", "v" },
        },
        {
          opts.mappings.refresh,
          function() require("avante.api").refresh() end,
          desc = "avante: refresh",
          mode = "v",
        },
        {
          opts.mappings.edit,
          function() require("avante.api").edit() end,
          desc = "avante: edit",
          mode = { "n", "v" },
        },
      }
      mappings = vim.tbl_filter(function(m) return m[1] and #m[1] > 0 end, mappings)
      return vim.list_extend(mappings, keys)
    end,

Important

If you have different keybinding, then update opts.mappings so that hint works accordingly.

If you are using lazy.nvim then use the snippet above.

{
  opts = {
    mappings = {
      ask = "<leader>ua", -- ask
      edit = "<leader>ue", -- edit
      refresh = "<leader>ur", -- refresh
    },
  }
}

extends apis and keybindings.

Read https://github.com/yetone/avante.nvim/blob/main/lua/avante/api.lua

custom .avanterules

All fields for all .avanterules are available here

clipboard.

If you wish to load img-clip.nvim via keys, you can use the following:

    keys = {
      {
        "<leader>ip",
        function()
          return vim.bo.filetype == "AvanteInput" and require("avante.clipboard").paste_image()
            or require("img-clip").paste_image()
        end,
        desc = "clip: paste image",
      },
    }

curl failed to writing to disk error

See https://github.com/yetone/avante.nvim/issues/315#issuecomment-2315957174

convert generated conflict to quickfix items

_G.convert_to_qf = function()
  require('avante.diff').conflicts_to_qf_items(function(items)
    if #items > 0 then
      vim.fn.setqflist(items, "r")
      vim.cmd('copen')
    end
  end)
end

Then you can call this function in mappings or anything you want to do with it.

dynamic window position

See https://github.com/yetone/avante.nvim/pull/527

wsl

Try set XDG_RUNTIME_DIR="/tmp/"

Clone this wiki locally