Augment Vim & Neovim Plugin
A Quick Tour
Augment’s Vim/Neovim plugin provides inline code completions and multi-turn
chat conversations specially tailored to your codebase. The plugin is designed
to work with any modern Vim or Neovim setup, and features the same underlying
context engine that powers our VSCode and IntelliJ plugins.
Once you’ve installed the plugin, tell Augment about your project by adding
workspace folders to your config file, and then sign-in
to the Augment service. You can now open a source file in your project, begin
typing, and you should receive context-aware code completions. Use tab to
accept a suggestion, or keep typing to refine the suggestions. To ask questions
about your codebase or request specific changes, use the :Augment chat command
to start a chat conversation.
Installation
Both Vim and Neovim are supported, but the plugin may require a newer version
than what’s installed on your system by default.
Vim version 9.1.0 or newer.
Neovim, version
0.10.0 or newer.
Install Node.js,
version 22.0.0 or newer, which is a required dependency.
Install the plugin
Manual installation (Vim):
git clone https://github.com/augmentcode/augment.vim.git
~/.vim/pack/augment/start/augment.vim
Manual installation (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’ },
Add workspace folders to your config file. This is really essential to getting the most out of augment! See the Workspace Folders section for more information.
Open Vim and sign in to Augment with the :Augment signin command.
Basic Usage
Open a file in vim, start typing, and use tab to accept suggestions as they
appear.
The following commands are provided:
