Install Augment for Vim and Neovim

​

About Installation

Installing Augment for Vim and Neovim 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:

​

1. Install the extension

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

require('lazy').setup({
  -- Your other plugins here
  'augmentcode/augment.vim',
})

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

require('lazy').setup({
  -- Your other plugins here
  'augmentcode/augment.vim',
})

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

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'}

Augment’s Context Engine provides the best suggestions when it has access to your project’s codebase and any related repositories. See more details in Configure additional workspace context.

​

3. Sign-in to Augment

Open Vim or Neovim and sign-in to Augment with the following command:

:Augment signin