Files

Dmitry Torokhov 2f9daf2bc6 feat(ollama): provide a helper to enable ollama when service is available

Ollama is disabled by default, as it normally does not require API keys
to be defined. Users are supposed to override is_env_set() method in
their configs to enable Ollama.

Provide check_endpoint_alive() helper in Ollama provider module that can
be used directly in place of is_env_set() and checks whether the server
replies to "get list of models" query:

...
  ollama = {
    is_env_set = require("avante.providers.ollama").check_endpoint_alive,
  },
...

2025-10-16 22:09:54 -07:00

46 KiB

Raw Blame History

avante.nvim

avante.nvim 是一个 Neovim 插件，旨在模拟 Cursor AI IDE 的行为。它为用户提供 AI 驱动的代码建议，并能够轻松地将这些建议直接应用到源文件中。

View in English

Note

🥰 该项目正在快速迭代中，许多令人兴奋的功能将陆续添加。敬请期待！

https://github.com/user-attachments/assets/510e6270-b6cf-459d-9a2f-15b397d1fe53

https://github.com/user-attachments/assets/86140bfd-08b4-483d-a887-1b701d9e37dd

赞助 ❤️

如果您喜欢这个项目，请考虑在 Patreon 上支持我，因为这有助于我继续维护和改进它：

赞助我

功能

AI 驱动的代码辅助：与 AI 互动，询问有关当前代码文件的问题，并接收智能建议以进行改进或修改。
一键应用：通过单个命令快速将 AI 的建议更改应用到源代码中，简化编辑过程并节省时间。

安装

如果您希望从源代码构建二进制文件，则需要 cargo。否则，将使用 curl 和 tar 从 GitHub 获取预构建的二进制文件。

lazy.nvim (推荐)

{
  "yetone/avante.nvim",
  -- 如果您想从源代码构建，请执行 `make BUILD_FROM_SOURCE=true`
  -- ⚠️ 一定要加上这一行配置！！！！！
  build = vim.fn.has("win32") ~= 0
      and "powershell -ExecutionPolicy Bypass -File Build.ps1 -BuildFromSource false"
      or "make",
  event = "VeryLazy",
  version = false, -- 永远不要将此值设置为 "*"！永远不要！
  ---@module 'avante'
  ---@type avante.Config
  opts = {
    -- 在此处添加任何选项
    -- 例如
    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,
          },
      },
      moonshot = {
        endpoint = "https://api.moonshot.ai/v1",
        model = "kimi-k2-0711-preview",
        timeout = 30000, -- 超时时间（毫秒）
          extra_request_body = {
            temperature = 0.75,
            max_tokens = 32768,
          },
      },
    },
  },
  dependencies = {
    "nvim-lua/plenary.nvim",
    "MunifTanjim/nui.nvim",
    --- 以下依赖项是可选的，
    "echasnovski/mini.pick", -- 用于文件选择器提供者 mini.pick
    "nvim-telescope/telescope.nvim", -- 用于文件选择器提供者 telescope
    "hrsh7th/nvim-cmp", -- avante 命令和提及的自动完成
    "ibhagwan/fzf-lua", -- 用于文件选择器提供者 fzf
    "nvim-tree/nvim-web-devicons", -- 或 echasnovski/mini.icons
    "zbirenbaum/copilot.lua", -- 用于 providers='copilot'
    {
      -- 支持图像粘贴
      "HakonHarnes/img-clip.nvim",
      event = "VeryLazy",
      opts = {
        -- 推荐设置
        default = {
          embed_image_as_base64 = false,
          prompt_for_file_name = false,
          drag_and_drop = {
            insert_mode = true,
          },
          -- Windows 用户必需
          use_absolute_path = true,
        },
      },
    },
    {
      -- 如果您有 lazy=true，请确保正确设置
      'MeanderingProgrammer/render-markdown.nvim',
      opts = {
        file_types = { "markdown", "Avante" },
      },
      ft = { "markdown", "Avante" },
    },
  },
}

vim-plug


" 依赖项
Plug 'nvim-lua/plenary.nvim'
Plug 'MunifTanjim/nui.nvim'
Plug 'MeanderingProgrammer/render-markdown.nvim'

" 可选依赖项
Plug 'hrsh7th/nvim-cmp'
Plug 'nvim-tree/nvim-web-devicons' "或 Plug 'echasnovski/mini.icons'
Plug 'HakonHarnes/img-clip.nvim'
Plug 'zbirenbaum/copilot.lua'

" Yay，如果您想从源代码构建，请传递 source=true
Plug 'yetone/avante.nvim', { 'branch': 'main', 'do': 'make' }
autocmd! User avante.nvim lua << EOF
require('avante').setup()
EOF

mini.deps

local add, later, now = MiniDeps.add, MiniDeps.later, MiniDeps.now

add({
  source = 'yetone/avante.nvim',
  monitor = 'main',
  depends = {
    'nvim-lua/plenary.nvim',
    'MunifTanjim/nui.nvim',
    'echasnovski/mini.icons'
  },
  hooks = { post_checkout = function() vim.cmd('make') end }
})
--- 可选
add({ source = 'hrsh7th/nvim-cmp' })
add({ source = 'zbirenbaum/copilot.lua' })
add({ source = 'HakonHarnes/img-clip.nvim' })
add({ source = 'MeanderingProgrammer/render-markdown.nvim' })

later(function() require('render-markdown').setup({...}) end)
later(function()
  require('img-clip').setup({...}) -- 配置 img-clip
  require("copilot").setup({...}) -- 根据您的喜好设置 copilot
  require("avante").setup({...}) -- 配置 avante.nvim
end)

Packer


  -- 必需插件
  use 'nvim-lua/plenary.nvim'
  use 'MunifTanjim/nui.nvim'
  use 'MeanderingProgrammer/render-markdown.nvim'

  -- 可选依赖项
  use 'hrsh7th/nvim-cmp'
  use 'nvim-tree/nvim-web-devicons' -- 或使用 'echasnovski/mini.icons'
  use 'HakonHarnes/img-clip.nvim'
  use 'zbirenbaum/copilot.lua'

  -- Avante.nvim 带有构建过程
  use {
    'yetone/avante.nvim',
    branch = 'main',
    run = 'make',
    config = function()
      require('avante').setup()
    end
  }

Home Manager

programs.neovim = {
  plugins = [
    {
      plugin = pkgs.vimPlugins.avante-nvim;
      type = "lua";
      config = ''
              require("avante_lib").load()
              require("avante").setup()
      '' # 或 builtins.readFile ./plugins/avante.lua;
    }
  ];
};

Nixvim

  plugins.avante.enable = true;
  plugins.avante.settings = {
    # 在此处设置选项
  };

Lua

-- 依赖项：
require('cmp').setup ({
  -- 使用上面的推荐设置
})
require('img-clip').setup ({
  -- 使用上面的推荐设置
})
require('copilot').setup ({
  -- 使用上面的推荐设置
})
require('render-markdown').setup ({
  -- 使用上面的推荐设置
})
require('avante').setup ({
  -- 在此处配置！
})

Important

avante.nvim 目前仅兼容 Neovim 0.10.1 或更高版本。请确保您的 Neovim 版本符合这些要求后再继续。

Note

在同步加载插件时，我们建议在您的配色方案之后的某个时间 require 它。

Note

推荐的 Neovim 选项：

-- 视图只能通过全局状态栏完全折叠
vim.opt.laststatus = 3

Tip

任何支持 markdown 的渲染插件都可以与 Avante 一起使用，只要您添加支持的文件类型 Avante。有关更多信息，请参见 https://github.com/yetone/avante.nvim/issues/175 和此评论。

默认设置配置

请参见 config.lua#L9 以获取完整配置

默认配置

{
  ---@alias Provider "claude" | "openai" | "azure" | "gemini" | "cohere" | "copilot" | string
  provider = "claude", -- 在 Aider 模式或 Cursor 规划模式的规划阶段使用的提供者
  -- 警告：由于自动建议是高频操作，因此成本较高，
  -- 目前将其指定为 `copilot` 提供者是危险的，因为：https://github.com/yetone/avante.nvim/issues/1048
  -- 当然，您可以通过增加 `suggestion.debounce` 来减少请求频率。
  auto_suggestions_provider = "claude",
  providers = {
    claude = {
      endpoint = "https://api.anthropic.com",
      model = "claude-3-5-sonnet-20241022",
      extra_request_body = {
        temperature = 0.75,
        max_tokens = 4096,
      },
    },
    moonshot = {
      endpoint = "https://api.moonshot.ai/v1",
      model = "kimi-k2-0711-preview",
      timeout = 30000, -- 超时时间（毫秒）
      extra_request_body = {
        temperature = 0.75,
        max_tokens = 32768,
      },
    },
  },
  ---指定特殊的 dual_boost 模式
  ---1. enabled: 是否启用 dual_boost 模式。默认为 false。
  ---2. first_provider: 第一个提供者用于生成响应。默认为 "openai"。
  ---3. second_provider: 第二个提供者用于生成响应。默认为 "claude"。
  ---4. prompt: 用于根据两个参考输出生成响应的提示。
  ---5. timeout: 超时时间（毫秒）。默认为 60000。
  ---工作原理：
  --- 启用 dual_boost 后，avante 将分别从 first_provider 和 second_provider 生成两个响应。然后使用 first_provider 的响应作为 provider1_output，second_provider 的响应作为 provider2_output。最后，avante 将根据提示和两个参考输出生成响应，默认提供者与正常情况相同。
  ---注意：这是一个实验性功能，可能无法按预期工作。
  dual_boost = {
    enabled = false,
    first_provider = "openai",
    second_provider = "claude",
    prompt = "根据以下两个参考输出，生成一个结合两者元素但反映您自己判断和独特视角的响应。不要提供任何解释，只需直接给出响应。参考输出 1: [{{provider1_output}}], 参考输出 2: [{{provider2_output}}]",
    timeout = 60000, -- 超时时间（毫秒）
  },
  behaviour = {
    auto_suggestions = false, -- 实验阶段
    auto_set_highlight_group = true,
    auto_set_keymaps = true,
    auto_apply_diff_after_generation = false,
    support_paste_from_clipboard = false,
    minimize_diff = true, -- 是否在应用代码块时删除未更改的行
    enable_token_counting = true, -- 是否启用令牌计数。默认为 true。
    auto_add_current_file = true, -- 打开新聊天时是否自动添加当前文件。默认为 true。
    enable_cursor_planning_mode = false, -- 是否启用 Cursor 规划模式。默认为 false。
    enable_claude_text_editor_tool_mode = false, -- 是否启用 Claude 文本编辑器工具模式。
    ---@type "popup" | "inline_buttons"
    confirmation_ui_style = "inline_buttons",
  },
  mappings = {
    --- @class AvanteConflictMappings
    diff = {
      ours = "co",
      theirs = "ct",
      all_theirs = "ca",
      both = "cb",
      cursor = "cc",
      next = "]x",
      prev = "[x",
    },
    suggestion = {
      accept = "<M-l>",
      next = "<M-]>",
      prev = "<M-[>",
      dismiss = "<C-]>",
    },
    jump = {
      next = "]]",
      prev = "[[",
    },
    submit = {
      normal = "<CR>",
      insert = "<C-s>",
    },
    cancel = {
      normal = { "<C-c>", "<Esc>", "q" },
      insert = { "<C-c>" },
    },
    sidebar = {
      apply_all = "A",
      apply_cursor = "a",
      retry_user_request = "r",
      edit_user_request = "e",
      switch_windows = "<Tab>",
      reverse_switch_windows = "<S-Tab>",
      remove_file = "d",
      add_file = "@",
      close = { "<Esc>", "q" },
      close_from_input = nil, -- 例如，{ normal = "<Esc>", insert = "<C-d>" }
    },
  },
  selection = {
    enabled = true,
    hint_display = "delayed",
  },
  windows = {
    ---@type "right" | "left" | "top" | "bottom"
    position = "right", -- 侧边栏的位置
    wrap = true, -- 类似于 vim.o.wrap
    width = 30, -- 默认基于可用宽度的百分比
    sidebar_header = {
      enabled = true, -- true, false 启用/禁用标题
      align = "center", -- left, center, right 用于标题
      rounded = true,
    },
    spinner = {
      editing = { "⡀", "⠄", "⠂", "⠁", "⠈", "⠐", "⠠", "⢀", "⣀", "⢄", "⢂", "⢁", "⢈", "⢐", "⢠", "⣠", "⢤", "⢢", "⢡", "⢨", "⢰", "⣰", "⢴", "⢲", "⢱", "⢸", "⣸", "⢼", "⢺", "⢹", "⣹", "⢽", "⢻", "⣻", "⢿", "⣿" },
      generating = { "·", "✢", "✳", "∗", "✻", "✽" }, -- '生成中' 状态的旋转字符
      thinking = { "🤯", "🙄" }, -- '思考中' 状态的旋转字符
    },
    input = {
      prefix = "> ",
      height = 8, -- 垂直布局中输入窗口的高度
    },
    edit = {
      border = "rounded",
      start_insert = true, -- 打开编辑窗口时开始插入模式
    },
    ask = {
      floating = false, -- 在浮动窗口中打开 'AvanteAsk' 提示
      start_insert = true, -- 打开询问窗口时开始插入模式
      border = "rounded",
      ---@type "ours" | "theirs"
      focus_on_apply = "ours", -- 应用后聚焦的差异
    },
  },
  highlights = {
    ---@type AvanteConflictHighlights
    diff = {
      current = "DiffText",
      incoming = "DiffAdd",
    },
  },
  --- @class AvanteConflictUserConfig
  diff = {
    autojump = true,
    ---@type string | fun(): any
    list_opener = "copen",
    --- 覆盖悬停在差异上时的 'timeoutlen' 设置（请参阅 :help timeoutlen）。
    --- 有助于避免进入以 `c` 开头的差异映射的操作员挂起模式。
    --- 通过设置为 -1 禁用。
    override_timeoutlen = 500,
  },
  suggestion = {
    debounce = 600,
    throttle = 600,
  },
}

Blink.cmp 用户

对于 blink cmp 用户（nvim-cmp 替代品），请查看以下配置说明这是通过使用 blink.compat 模拟 nvim-cmp 实现的或者您可以使用 Kaiser-Yang/blink-cmp-avante。

Lua

      selector = {
        --- @alias avante.SelectorProvider "native" | "fzf_lua" | "mini_pick" | "snacks" | "telescope" | fun(selector: avante.ui.Selector): nil
        provider = "fzf",
        -- 自定义提供者的选项覆盖
        provider_opts = {},
      }

要创建自定义选择器，您可以指定一个自定义函数来启动选择器以选择项目，并将选定的项目传递给 on_select 回调。

      selector = {
        ---@param selector avante.ui.Selector
        provider = function(selector)
          local items = selector.items ---@type avante.ui.SelectorItem[]
          local title = selector.title ---@type string
          local on_select = selector.on_select ---@type fun(selected_item_ids: string[]|nil): nil

          --- 在这里添加您的自定义选择器逻辑
        end,
      }

选择 native 以外的选择器，默认情况下目前存在问题对于 lazyvim 用户，请从网站复制 blink.cmp 的完整配置或扩展选项

      compat = {
        "avante_commands",
        "avante_mentions",
        "avante_files",
      }

对于其他用户，只需添加自定义提供者

可用的补全项

Avante.nvim 提供了多个可以与 blink.cmp 集成的补全项：

提及功能 (`@` 触发器)

提及功能允许您快速引用特定功能或将文件添加到聊天上下文：

@codebase - 启用项目上下文和仓库映射
@diagnostics - 启用诊断信息
@file - 打开文件选择器以将文件添加到聊天上下文
@quickfix - 将快速修复列表中的文件添加到聊天上下文
@buffers - 将打开的缓冲区添加到聊天上下文

斜杠命令 (`/` 触发器)

内置斜杠命令用于常见操作：

/help - 显示可用命令的帮助信息
/init - 基于当前项目初始化 AGENTS.md
/clear - 清除聊天历史
/new - 开始新聊天
/compact - 压缩历史消息以节省令牌
/lines <start>-<end> <question> - 询问特定行的问题
/commit - 为更改生成提交消息

快捷方式 (`#` 触发器)

快捷方式提供对预定义提示模板的快速访问。您可以在配置中自定义这些：

{
  shortcuts = {
    {
      name = "refactor",
      description = "使用最佳实践重构代码",
      details = "自动重构代码以提高可读性、可维护性，并遵循最佳实践，同时保持功能不变",
      prompt = "请按照最佳实践重构此代码，提高可读性和可维护性，同时保持功能不变。"
    },
    {
      name = "test",
      description = "生成单元测试",
      details = "创建全面的单元测试，涵盖边界情况、错误场景和各种输入条件",
      prompt = "请为此代码生成全面的单元测试，涵盖边界情况和错误场景。"
    },
    -- 添加更多自定义快捷方式...
  }
}

当您在输入中键入 #refactor 时，它将自动替换为相应的提示文本。

配置示例

以下是包含所有 Avante 源的完整 blink.cmp 配置示例：

      default = {
        ...
        "avante_commands",
        "avante_mentions",
        "avante_shortcuts",
        "avante_files",
      }

      providers = {
        avante_commands = {
          name = "avante_commands",
          module = "blink.compat.source",
          score_offset = 90, -- 显示优先级高于 lsp
          opts = {},
        },
        avante_files = {
          name = "avante_files",
          module = "blink.compat.source",
          score_offset = 100, -- 显示优先级高于 lsp
          opts = {},
        },
        avante_mentions = {
          name = "avante_mentions",
          module = "blink.compat.source",
          score_offset = 1000, -- 显示优先级高于 lsp
          opts = {},
        },
        avante_shortcuts = {
          name = "avante_shortcuts",
          module = "blink.compat.source",
          score_offset = 1000, -- 显示优先级高于 lsp
          opts = {},
        }
        ...
    }

用法

鉴于其早期阶段，avante.nvim 目前支持以下基本功能：

Important

为了在 neovim 会话之间保持一致性，建议在 shell 文件中设置环境变量。默认情况下，Avante 会在启动时提示您输入所选提供者的 API 密钥。

作用域 API 密钥（推荐用于隔离）

Avante 现在支持作用域 API 密钥，允许您专门为 Avante 隔离 API 密钥，而不影响其他应用程序。只需在任何 API 密钥前加上 AVANTE_ 前缀：
# 作用域密钥（推荐）
export AVANTE_ANTHROPIC_API_KEY=your-claude-api-key
export AVANTE_OPENAI_API_KEY=your-openai-api-key
export AVANTE_AZURE_OPENAI_API_KEY=your-azure-api-key
export AVANTE_GEMINI_API_KEY=your-gemini-api-key
export AVANTE_CO_API_KEY=your-cohere-api-key
export AVANTE_AIHUBMIX_API_KEY=your-aihubmix-api-key
export AVANTE_MOONSHOT_API_KEY=your-moonshot-api-key
全局 API 密钥（传统方式）

如果您愿意，仍然可以使用传统的全局 API 密钥：

对于 Claude：
export ANTHROPIC_API_KEY=your-api-key
对于 OpenAI：
export OPENAI_API_KEY=your-api-key
对于 Azure OpenAI：
export AZURE_OPENAI_API_KEY=your-api-key
对于 Amazon Bedrock：
export BEDROCK_KEYS=aws_access_key_id,aws_secret_access_key,aws_region[,aws_session_token]
注意：aws_session_token 是可选的，仅在使用临时 AWS 凭证时需要

在 Neovim 中打开代码文件。
使用 :AvanteAsk 命令查询 AI 关于代码的问题。
查看 AI 的建议。
通过简单的命令或按键绑定将推荐的更改直接应用到代码中。

注意：该插件仍在积极开发中，其功能和界面可能会发生重大变化。随着项目的发展，预计会有一些粗糙的边缘和不稳定性。

键绑定

以下键绑定可用于 avante.nvim：

键绑定	描述
`Leaderaa`	显示侧边栏
`Leaderat`	切换侧边栏可见性
`Leaderar`	刷新侧边栏
`Leaderaf`	切换侧边栏焦点
`Leadera?`	选择模型
`Leaderae`	编辑选定的块
`LeaderaS`	停止当前 AI 请求
`co`	选择我们的
`ct`	选择他们的
`ca`	选择所有他们的
`c0`	选择无
`cb`	选择两者
`cc`	选择光标
`]x`	移动到上一个冲突
`[x`	移动到下一个冲突
`[[`	跳转到上一个代码块 (结果窗口)
`]]`	跳转到下一个代码块 (结果窗口)

Note

如果您使用 lazy.nvim，那么此处的所有键映射都将安全设置，这意味着如果 <leader>aa 已经绑定，则 avante.nvim 不会绑定此映射。在这种情况下，用户将负责设置自己的。有关更多详细信息，请参见关于键映射的说明。

Neotree 快捷方式

在 neotree 侧边栏中，您还可以添加新的键盘快捷方式，以快速将 file/folder 添加到 Avante Selected Files。

Neotree 配置

return {
  {
    'nvim-neo-tree/neo-tree.nvim',
    config = function()
      require('neo-tree').setup({
        filesystem = {
          commands = {
            avante_add_files = function(state)
              local node = state.tree:get_node()
              local filepath = node:get_id()
              local relative_path = require('avante.utils').relative_path(filepath)

              local sidebar = require('avante').get()

              local open = sidebar:is_open()
              -- 确保 avante 侧边栏已打开
              if not open then
                require('avante.api').ask()
                sidebar = require('avante').get()
              end

              sidebar.file_selector:add_selected_file(relative_path)

              -- 删除 neo tree 缓冲区
              if not open then
                sidebar.file_selector:remove_selected_file('neo-tree filesystem [1]')
              end
            end,
          },
          window = {
            mappings = {
              ['oa'] = 'avante_add_files',
            },
          },
        },
      })
    end,
  },
}

命令

命令	描述	示例
`:AvanteAsk [question] [position]`	询问 AI 关于您的代码的问题。可选的 `position` 设置窗口位置和 `ask` 启用/禁用直接询问模式	`:AvanteAsk position=right Refactor this code here`
`:AvanteBuild`	构建项目的依赖项
`:AvanteChat`	启动与 AI 的聊天会话，讨论您的代码库。默认情况下 `ask`=false
`:AvanteClear`	清除聊天记录
`:AvanteEdit`	编辑选定的代码块
`:AvanteFocus`	切换焦点到/从侧边栏
`:AvanteRefresh`	刷新所有 Avante 窗口
`:AvanteStop`	停止当前 AI 请求
`:AvanteSwitchProvider`	切换 AI 提供者（例如 openai）
`:AvanteShowRepoMap`	显示项目结构的 repo map
`:AvanteToggle`	切换 Avante 侧边栏
`:AvanteModels`	显示模型列表

高亮组

高亮组	描述	备注
AvanteTitle	标题
AvanteReversedTitle	用于圆角边框
AvanteSubtitle	选定代码标题
AvanteReversedSubtitle	用于圆角边框
AvanteThirdTitle	提示标题
AvanteReversedThirdTitle	用于圆角边框
AvanteConflictCurrent	当前冲突高亮	默认值为 `Config.highlights.diff.current`
AvanteConflictIncoming	即将到来的冲突高亮	默认值为 `Config.highlights.diff.incoming`
AvanteConflictCurrentLabel	当前冲突标签高亮	默认值为 `AvanteConflictCurrent` 的阴影
AvanteConflictIncomingLabel	即将到来的冲突标签高亮	默认值为 `AvanteConflictIncoming` 的阴影
AvantePopupHint	弹出菜单中的使用提示
AvanteInlineHint	在可视模式下显示的行尾提示

有关更多信息，请参见 highlights.lua

Ollama

ollama 是 avante.nvim 的一流提供者。要开始使用它，您需要在配置中设置 provider = "ollama"，并将 ollama 中的 model 字段设置为您想要使用的模型。Ollama 默认是禁用的，您需要为其 is_env_set 方法提供一个实现来正确地启用它。例如：

provider = "ollama",
providers = {
  ollama = {
    model = "qwq:32b",
    is_env_set = require("avante.providers.ollama").check_endpoint_alive,
  },
}

自定义提供者

Avante 提供了一组默认提供者，但用户也可以创建自己的提供者。

有关更多信息，请参见自定义提供者

Cursor 规划模式

因为 avante.nvim 一直使用 Aider 的方法进行规划应用，但其提示对模型要求很高，需要像 claude-3.5-sonnet 或 gpt-4o 这样的模型才能正常工作。

因此，我采用了 Cursor 的方法来实现规划应用。有关实现的详细信息，请参阅 cursor-planning-mode.md

RAG 服务

Avante 提供了一个 RAG 服务，这是一个用于获取 AI 生成代码所需上下文的工具。默认情况下，它未启用。您可以通过以下方式启用它：

  rag_service = { -- RAG 服务配置
    enabled = false, -- 启用 RAG 服务
    host_mount = os.getenv("HOME"), -- RAG 服务的主机挂载路径 (Docker 将挂载此路径)
    runner = "docker", -- RAG 服务的运行器 (可以使用 docker 或 nix)
    llm = { -- RAG 服务使用的语言模型 (LLM) 配置
      provider = "openai", -- LLM 提供者
      endpoint = "https://api.openai.com/v1", -- LLM API 端点
      api_key = "OPENAI_API_KEY", -- LLM API 密钥的环境变量名称
      model = "gpt-4o-mini", -- LLM 模型名称
      extra = nil, -- LLM 的额外配置选项
    },
    embed = { -- RAG 服务使用的嵌入模型配置
      provider = "openai", -- 嵌入提供者
      endpoint = "https://api.openai.com/v1", -- 嵌入 API 端点
      api_key = "OPENAI_API_KEY", -- 嵌入 API 密钥的环境变量名称
      model = "text-embedding-3-large", -- 嵌入模型名称
      extra = nil, -- 嵌入模型的额外配置选项
    },
    docker_extra_args = "", -- 传递给 docker 命令的额外参数
  },

RAG 服务可以单独设置llm模型和嵌入模型。在 llm 和 embed 配置块中，您可以设置以下字段：

provider: 模型提供者（例如 "openai", "ollama", "dashscope"以及"openrouter"）
endpoint: API 端点
api_key: API 密钥的环境变量名称
model: 模型名称
extra: 额外的配置选项

有关不同模型提供商的详细配置，你可以在这里查看。

此外，RAG 服务还依赖于 Docker！（对于 macOS 用户，推荐使用 OrbStack 作为 Docker 的替代品）。

host_mount 是将挂载到容器的路径，默认是主目录。挂载是 RAG 服务访问主机机器中文件所必需的。用户可以决定是否要挂载整个 / 目录、仅项目目录或主目录。如果您计划使用 avante 和 RAG 事件处理存储在主目录之外的项目，您需要将 host_mount 设置为文件系统的根目录。

挂载将是只读的。

更改 rag_service 配置后，您需要手动删除 rag_service 容器以确保使用新配置：docker rm -fv avante-rag-service

Web 搜索引擎

Avante 的工具包括一些 Web 搜索引擎，目前支持：

默认是 Tavily，可以通过配置 Config.web_search_engine.provider 进行更改：

web_search_engine = {
  provider = "tavily", -- tavily, serpapi, google, kagi, brave 或 searxng
  proxy = nil, -- proxy support, e.g., http://127.0.0.1:7890
}

提供者所需的环境变量：

Tavily: TAVILY_API_KEY
SerpApi: SERPAPI_API_KEY
Google:
- GOOGLE_SEARCH_API_KEY 作为 API 密钥
- GOOGLE_SEARCH_ENGINE_ID 作为搜索引擎 ID
Kagi: KAGI_API_KEY 作为 API 令牌
Brave Search: BRAVE_API_KEY 作为 API 密钥
SearXNG: SEARXNG_API_URL 作为 API URL

禁用工具

Avante 默认启用工具，但某些 LLM 模型不支持工具。您可以通过为提供者设置 disable_tools = true 来禁用工具。例如：

{
  claude = {
    endpoint = "https://api.anthropic.com",
    model = "claude-3-5-sonnet-20241022",
    timeout = 30000, -- 超时时间（毫秒）
    temperature = 0,
    max_tokens = 4096,
    disable_tools = true, -- 禁用工具！
  },
}

如果您想禁止某些工具以避免其使用（例如 Claude 3.7 过度使用 python 工具），您可以仅禁用特定工具

{
  disabled_tools = { "python" },
}

工具列表

rag_search, python, git_diff, git_commit, glob, search_keyword, read_file_toplevel_symbols, read_file, create_file, move_path, copy_path, delete_path, create_dir, bash, web_search, fetch

自定义工具

Avante 允许您定义自定义工具，AI 可以在代码生成和分析期间使用这些工具。这些工具可以执行 shell 命令、运行脚本或执行您需要的任何自定义逻辑。

示例：Go 测试运行器

以下是一个运行 Go 单元测试的自定义工具示例：

{
  custom_tools = {
    {
      name = "run_go_tests",  -- 工具的唯一名称
      description = "运行 Go 单元测试并返回结果",  -- 显示给 AI 的描述
      command = "go test -v ./...",  -- 要执行的 shell 命令
      param = {  -- 输入参数（可选）
        type = "table",
        fields = {
          {
            name = "target",
            description = "要测试的包或目录（例如 './pkg/...' 或 './internal/pkg'）",
            type = "string",
            optional = true,
          },
        },
      },
      returns = {  -- 预期返回值
        {
          name = "result",
          description = "获取的结果",
          type = "string",
        },
        {
          name = "error",
          description = "如果获取不成功的错误消息",
          type = "string",
          optional = true,
        },
      },
      func = function(params, on_log, on_complete)  -- 要执行的自定义函数
        local target = params.target or "./..."
        return vim.fn.system(string.format("go test -v %s", target))
      end,
    },
  },
}

MCP

现在您可以通过 mcphub.nvim 为 Avante 集成 MCP 功能。有关详细文档，请参阅 mcphub.nvim

Claude 文本编辑器工具模式

Avante 利用 Claude 文本编辑器工具提供更优雅的代码编辑体验。您现在可以通过在 behaviour 配置中将 enable_claude_text_editor_tool_mode 设置为 true 来启用此功能：

{
  behaviour = {
    enable_claude_text_editor_tool_mode = true,
  },
}

Note

要启用 Claude 文本编辑器工具模式，您必须使用 claude-3-5-sonnet-* 或 claude-3-7-sonnet-* 模型与 claude 提供者！此功能不支持任何其他模型！

自定义提示

默认情况下，avante.nvim 提供三种不同的模式进行交互：planning、editing 和 suggesting，每种模式都有三种不同的提示。

planning：与侧边栏上的 require("avante").toggle() 一起使用
editing：与选定代码块上的 require("avante").edit() 一起使用
suggesting：与 Tab 流上的 require("avante").get_suggestion():suggest() 一起使用。
cursor-planning：与 Tab 流上的 require("avante").toggle() 一起使用，但仅在启用 cursor 规划模式时。

用户可以通过 Config.system_prompt 或 Config.override_prompt_dir 自定义系统提示。

Config.system_prompt 允许您设置全局系统提示。我们建议根据您的需要在自定义 Autocmds 中调用此方法：

vim.api.nvim_create_autocmd("User", {
  pattern = "ToggleMyPrompt",
  callback = function() require("avante.config").override({system_prompt = "MY CUSTOM SYSTEM PROMPT"}) end,
})

vim.keymap.set("n", "<leader>am", function() vim.api.nvim_exec_autocmds("User", { pattern = "ToggleMyPrompt" }) end, { desc = "avante: toggle my prompt" })

Config.override_prompt_dir 允许您指定一个目录，其中包含您自己的自定义提示模板，这将覆盖内置模板。如果您想在 Neovim 配置之外维护一组自定义提示，这将非常有用。它可以是一个表示目录路径的字符串，也可以是一个返回表示目录路径的字符串的函数。

-- 示例：使用特定目录中的提示进行覆盖
require("avante").setup({
  override_prompt_dir = vim.fn.expand("~/.config/nvim/avante_prompts"),
})

-- 示例：使用函数（动态目录）中的提示进行覆盖
require("avante").setup({
  override_prompt_dir = function()
    -- 确定提示目录的逻辑
    return vim.fn.expand("~/.config/nvim/my_dynamic_prompts")
  end,
})

Warning

如果您自定 base.avanterules，请一定要确保 {% block custom_prompt %}{% endblock %} 和 {% block extra_prompt %}{% endblock %} 存在，否则可能会导致整个插件无法使用。如果您不清楚具体原因或者您不知道自己在干什么，请不要覆盖内置 prompt。内置 prompt 工作得非常好。

如果希望为每种模式自定义提示，avante.nvim 将根据给定缓冲区的项目根目录检查是否包含以下模式：*.{mode}.avanterules。

根目录层次结构的规则：

lsp 工作区文件夹
lsp root_dir
当前缓冲区的文件名的根模式
cwd 的根模式

您还可以使用 rules 选项为您的 avanterules 文件配置自定义目录：

require('avante').setup({
  rules = {
    project_dir = '.avante/rules', -- 相对于项目根目录，也可以是绝对路径
    global_dir = '~/.config/avante/rules', -- 绝对路径
  },
})

加载优先级如下：

rules.project_dir
rules.global_dir
项目根目录

自定义提示的示例文件夹结构

如果您有以下结构：

.
├── .git/
├── typescript.planning.avanterules
├── snippets.editing.avanterules
├── suggesting.avanterules
└── src/

typescript.planning.avanterules 将用于 planning 模式
snippets.editing.avanterules 将用于 editing 模式
suggesting.avanterules 将用于 suggesting 模式。

Important

*.avanterules 是一个 jinja 模板文件，将使用 minijinja 渲染。有关如何扩展当前模板的示例，请参见 templates。

集成

Avante.nvim 可以通过其扩展模块与其他插件协同工作。下面是一个将 Avante 与 nvim-tree 集成的示例，允许你直接从 NvimTree UI 中选择或取消选择文件：

{
    "yetone/avante.nvim",
    event = "VeryLazy",
    keys = {
        {
            "<leader>a+",
            function()
                local tree_ext = require("avante.extensions.nvim_tree")
                tree_ext.add_file()
            end,
            desc = "Select file in NvimTree",
            ft = "NvimTree",
        },
        {
            "<leader>a-",
            function()
                local tree_ext = require("avante.extensions.nvim_tree")
                tree_ext.remove_file()
            end,
            desc = "Deselect file in NvimTree",
            ft = "NvimTree",
        },
    },
    opts = {
        --- 其他配置
        selector = {
            exclude_auto_select = { "NvimTree" },
        },
    },
}

TODOs

与当前文件聊天
应用差异补丁
与选定的块聊天
斜杠命令
编辑选定的块
智能 Tab（Cursor 流）
与项目聊天（您可以使用 @codebase 与整个项目聊天）
与选定文件聊天
工具使用
MCP
更好的代码库索引

路线图

增强的 AI 交互：提高 AI 分析和建议的深度，以应对更复杂的编码场景。
LSP + Tree-sitter + LLM 集成：与 LSP 和 Tree-sitter 以及 LLM 集成，以提供更准确和强大的代码建议和分析。

贡献

欢迎为 avante.nvim 做出贡献！如果您有兴趣提供帮助，请随时提交拉取请求或打开问题。在贡献之前，请确保您的代码已经过彻底测试。

有关更多配方和技巧，请参见 wiki。

致谢

我们要向以下开源项目的贡献者表示衷心的感谢，他们的代码为 avante.nvim 的开发提供了宝贵的灵感和参考：

Nvim 插件	许可证	功能	位置
git-conflict.nvim	无许可证	差异比较功能	lua/avante/diff.lua
ChatGPT.nvim	Apache 2.0 许可证	令牌计数的计算	lua/avante/utils/tokens.lua
img-clip.nvim	MIT 许可证	剪贴板图像支持	lua/avante/clipboard.lua
copilot.lua	MIT 许可证	Copilot 支持	lua/avante/providers/copilot.lua
jinja.vim	MIT 许可证	模板文件类型支持	syntax/jinja.vim
codecompanion.nvim	MIT 许可证	Secrets 逻辑支持	lua/avante/providers/init.lua
aider	Apache 2.0 许可证	规划模式用户提示	lua/avante/templates/planning.avanterules

这些项目的源代码的高质量和独创性在我们的开发过程中提供了极大的帮助。我们向这些项目的作者和贡献者表示诚挚的感谢和敬意。正是开源社区的无私奉献推动了像 avante.nvim 这样的项目向前发展。

商业赞助商

Meshy AI

为创作者提供的 #1 AI 3D 模型生成器

BabelTower API

无需帐户，立即使用任何模型

许可证

avante.nvim 根据 Apache 2.0 许可证授权。有关更多详细信息，请参阅 LICENSE 文件。

46 KiB Raw Blame History Unescape Escape