Documentation Index
Fetch the complete documentation index at: https://docs.augmentcode.com/llms.txt
Use this file to discover all available pages before exploring further.
Get the Augment Extension
View Augment for Vim and Neovim on GitHub
About Installation
Installing is easy and will take you less than a minute. You can install the extension manually or you can use your favorite plugin manager.
Prerequisites
Augment for Vim and Neovim requires a compatible version of Vim or Neovim, and Node.js:
| Dependency | Minimum version |
|---|
| Vim | 9.1.0 |
| Neovim | 0.10.0 |
| Node.js | 22.0.0 |
1. Install the extension
Manual Installation
git clone https://github.com/augmentcode/augment.vim.git ~/.config/nvim/pack/augment/start/augment.vim
Using Lazy.nvim
Add the following to your init.lua file, then run :Lazy sync in Neovim. See more details about using Lazy.nvim on GitHub.require('lazy').setup({
-- Your other plugins here
'augmentcode/augment.vim',
})
Manual Installation
git clone https://github.com/augmentcode/augment.vim.git ~/.vim/pack/augment/start/augment.vim
Using Vim Plug
Add the following to your .vimrc file, then run :PlugInstall in Vim. See more details about using Vim Plug on GitHub.call plug#begin()
" Your other plugins here
Plug 'augmentcode/augment.vim'
call plug#end()
2. Configure your workspace context
Add your project root to your workspace context by setting g:augment_workspace_folders in your .vimrc or init.lua file before the plugin is loaded. For example:
" Add to your .vimrc
let g:augment_workspace_folders = ['/path/to/project']
" Add to your init.lua
vim.g.augment_workspace_folders = {'/path/to/project'}
3. Sign-in to Augment
Open Vim or Neovim and sign-in to Augment with the following command:
