Augment Vim & Neovim 插件

快速入门

Augment 的 Vim/Neovim 插件提供内联代码补全和多轮聊天对话，这些功能专为您的代码库量身定制。该插件设计用于与任何现代 Vim 或 Neovim 环境无缝协作，并采用了与我们的 VSCode 和 IntelliJ 插件相同的底层上下文引擎。

安装插件后，您需要通过在配置文件中添加工作区文件夹来告知 Augment 您的项目信息，然后登录 Augment 服务。之后，您可以在项目中打开一个源文件并开始输入，系统应会为您提供基于上下文的代码补全建议。您可以使用 Tab 键接受建议，也可以继续输入以进一步优化建议。若要询问有关代码库的问题或请求特定更改，可以使用 :Augment chat 命令启动聊天对话。

开始使用

1. 在 augmentcode.com 注册 Augment 的免费试用版。

2. 确保已安装兼容的编辑器版本。Vim 和 Neovim 均受支持，但该插件可能需要比系统默认安装的更新版本。

   • 对于 Vim，版本需为 9.1.0 或更高。

   • 对于 Neovim，版本需为 0.10.0 或更高。

3. 安装 Node.js，版本需为 22.0.0 或更高，这是必需的依赖项。

4. 安装插件：

   • 手动安装（Vim）：

     git clone https://github.com/augmentcode/augment.vim.git ~/.vim/pack/augment/start/augment.vim
     

   • 手动安装（Neovim）：

     git clone https://github.com/augmentcode/augment.vim.git ~/.config/nvim/pack/augment/start/augment.vim
     

   • Vim Plug：

     Plug 'augmentcode/augment.vim'
     

   • Lazy.nvim：

     { 'augmentcode/augment.vim' },
     

5. 在配置文件中添加工作区文件夹。这是充分发挥 Augment 功能的关键步骤！更多信息请参阅工作区文件夹部分。

6. 打开 Vim 并使用 :Augment signin 命令登录 Augment。

基本用法

在 Vim 中打开一个文件，开始输入，并在出现建议时使用 Tab 键接受。

插件提供了以下命令：

:Augment status        " 查看插件当前状态
:Augment signin        " 启动登录流程
:Augment signout       " 退出 Augment 登录
:Augment log           " 查看插件日志
:Augment chat          " 向 Augment AI 发送聊天消息
:Augment chat-new      " 开始新的聊天对话
:Augment chat-toggle   " 切换聊天面板的可见性

工作区文件夹

工作区文件夹通过提供额外的上下文，帮助 Augment 更好地理解您的代码库。将项目的根目录添加为工作区文件夹，可以让 Augment 利用整个项目中的上下文信息，而不仅仅是当前打开的文件，从而提高补全和聊天的准确性和一致性。

您可以通过在 vimrc 文件中设置 g:augment_workspace_folders 来配置工作区文件夹：

let g:augment_workspace_folders = ['/path/to/project', '~/another-project']

工作区文件夹可以使用绝对路径或相对于用户主目录 (~) 的路径来指定。将项目根目录添加为工作区文件夹，有助于 Augment 生成符合您代码库风格和规范的补全建议。

注意：此选项必须在插件加载之前设置。

添加工作区文件夹并重启 Vim 后，:Augment status 命令的输出将包含已添加文件夹的同步进度。

如果您希望忽略工作区中的某些文件或目录，可以在工作区文件夹的根目录下创建 .augmentignore 文件。该文件的处理方式类似于 .gitignore 文件。例如，要忽略 node_modules 目录中的所有文件，您可以在 .augmentignore 文件中添加以下内容：

node_modules/

有关如何使用 .augmentignore 文件的更多信息，请参阅 文档。

聊天

Augment 聊天支持利用项目完整上下文的多轮对话。一旦开始对话，后续的每轮交流都会包含之前的对话历史。这对于提出后续问题或获取特定于上下文的帮助非常有用。

您可以通过两种方式与聊天交互：

1. 直接输入命令及消息：

   :Augment chat 如何实现二分查找？
   

2. 使用选中文本：

   • 在可视模式下选择文本
   • 输入 :Augment chat，后跟您对所选内容的提问 随后，回复将以 Markdown 格式显示在一个独立的聊天缓冲区中。

要开始新的对话，可以使用 :Augment chat-new 命令。这将清除上下文中已有的聊天记录。

使用 :Augment chat-toggle 命令可以打开或关闭聊天面板。当聊天面板关闭时，聊天对话仍会被保留，可通过同一命令重新打开。

替代快捷键

默认情况下，Tab 键用于接受建议。如果您想使用其他按键，可以创建一个调用 augment#Accept() 的映射。该函数接受一个可选参数，用于指定在没有可用建议时插入的后备文本。

" 使用 Ctrl-Y 接受建议
inoremap <c-y> <cmd>call augment#Accept()<cr>

" 使用 Enter 接受建议，若无建议则插入换行符
inoremap <cr> <cmd>call augment#Accept("\n")<cr>

默认的 Tab 映射可以通过在插件加载前设置 g:augment_disable_tab_mapping = v:true 来禁用。

您还可以通过在 vimrc 中或编辑过程中随时设置 g:augment_disable_completions = v:true 来完全禁用代码补全功能。

如果其他插件在插入模式下使用了 Tab 键，Augment 的 Tab 映射可能会被覆盖，具体取决于插件加载的顺序。如果 Tab 键无法正常工作，可以使用 imap <tab> 命令检查该映射是否存在。

常见问题解答

问：我没有看到任何补全提示。插件是否正常工作？

答：您可以先检查 :Augment status 命令的输出。该命令会显示插件的当前状态，包括您是否已登录以及工作区文件夹是否已同步。如果您尚未登录，需要使用 :Augment signin 命令进行登录。如果这些信息并未显示问题，您可以使用 :Augment log 命令查看插件日志，以了解可能发生的错误。

问：我可以为 Augment 命令创建快捷键吗？

答：当然可以！您可以为任何 Augment 命令创建映射。例如，要为 :Augment chat* 命令创建快捷键，可以在您的 vimrc 文件中添加以下内容：

nnoremap <leader>ac :Augment chat<CR>
vnoremap <leader>ac :Augment chat<CR>
nnoremap <leader>an :Augment chat-new<CR>
nnoremap <leader>at :Augment chat-toggle<CR>

问：我的工作区同步花费了很长时间。我该怎么办？

答：如果您的代码库非常庞大且之前从未同步过，同步可能需要较长时间。此外，无意中包含像 node_modules/ 这样的大目录也很常见。您可以使用 :Augment status 查看同步进度。如果同步正在进行但速度很慢，建议检查是否存在不需要同步的大目录。您可以将这些目录添加到 .augmentignore 文件中，以将其排除在同步之外。如果您仍然遇到问题，请提交一个 GitHub 问题，并附上问题描述及 :Augment log 的输出。

许可与分发

本仓库包含两个主要组件：

1. Vim 插件： 包括仓库中除 dist 文件夹外的所有文件。这些文件采用 MIT 许可证 许可。
2. 服务器（dist 文件夹）： 该文件为专有软件，采用 自定义专有许可证 许可。

有关使用限制的详细信息，请参阅 LICENSE.md 文件。

报告问题

我们鼓励用户直接向我们报告任何错误或问题。请使用本仓库的 Issues 部分分享您的反馈。

如有其他问题，欢迎随时联系 support@augmentcode.com。

Augment.vim 快速上手指南

Augment 是一款专为 Vim 和 Neovim 设计的 AI 编程助手插件，提供基于项目上下文的行内代码补全和多轮对话功能。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 编辑器版本：
  • Vim: 9.1.0 或更高版本
  • Neovim: 0.10.0 或更高版本
• 前置依赖：
  • Node.js: 22.0.0 或更高版本（必需）

提示：如果系统默认包管理器提供的版本过旧，建议通过官方源或版本管理工具（如 nvm）安装最新版的 Node.js。

安装步骤

1. 注册账号

访问 augmentcode.com 注册免费试用账号。

2. 安装插件

根据您的插件管理器选择以下一种方式安装：

方式 A：使用 vim-plug 在 .vimrc 或 init.vim 中添加：

Plug 'augmentcode/augment.vim'

然后重启 Vim 并运行 :PlugInstall。

方式 B：使用 lazy.nvim (Neovim) 在配置文件中添加：

{ 'augmentcode/augment.vim' },

方式 C：手动安装

• Vim:

  git clone https://github.com/augmentcode/augment.vim.git \
      ~/.vim/pack/augment/start/augment.vim
  

• Neovim:

  git clone https://github.com/augmentcode/augment.vim.git \
      ~/.config/nvim/pack/augment/start/augment.vim
  

3. 配置工作区 (关键步骤)

为了让 AI 理解您的整个项目上下文，必须在插件加载前配置工作区文件夹。请在配置文件（.vimrc 或 init.lua 对应的 vimscript 部分）中添加：

" 将路径替换为您项目的实际根目录
let g:augment_workspace_folders = ['/path/to/your/project']

支持绝对路径或以 ~ 开头的相对路径。

4. 登录服务

重启编辑器后，运行以下命令进行登录：

:Augment signin

按照提示完成认证流程。

基本使用

代码补全

1. 打开项目中的源代码文件。
2. 开始输入代码，AI 会根据项目上下文提供灰色的补全建议。
3. 按 Tab 键接受建议，或继续打字以忽略建议。

AI 对话

您可以随时与 AI 讨论代码或请求修改：

• 直接提问：

  :Augment chat 如何实现二分查找？
  

• 基于选中代码提问：
  1. 在可视模式（Visual Mode）下选中代码。
  2. 输入 :Augment chat 并按回车，随后输入您的问题。

回答将在独立的聊天缓冲区中以 Markdown 格式显示。

常用命令速查

命令	功能描述
:Augment status	查看插件状态及工作区同步进度
:Augment chat	发送消息或开始对话
:Augment chat-new	开启新的对话会话（清除历史）
:Augment chat-toggle	显示/隐藏聊天面板
:Augment log	查看插件日志（用于排查问题）

自定义快捷键 (可选)

默认使用 Tab 接受补全。如需修改，可在配置中映射 augment#Accept() 函数：

" 使用 Ctrl-Y 接受建议
inoremap <c-y> <cmd>call augment#Accept()<cr>

" 使用 Enter 接受建议，若无建议则换行
inoremap <cr> <cmd>call augment#Accept("\n")<cr>