This plugin allows the Amp CLI to see the file you currently have open in your Neovim instance, along with your cursor position and your text selection.
amp.nvim.mp4
When installed, this plugin allows Neovim to:
- Notify Amp about currently open file
- Notify Amp about selected code
- Provide Neovim diagnostics to Amp on request
- Send messages to the Amp agent (see Sending Messages to Amp)
- Read and edit files through the Neovim buffers
- Automatically reconnects when you restart Neovim in the same directory
Install the plugin by adding this code to your lazy.vim config:
-- Amp Plugin
{
"sourcegraph/amp.nvim",
branch = "main",
lazy = false,
opts = { auto_start = true, log_level = "info" },
}local MiniDeps = require('mini.deps')
MiniDeps.add({
source = 'sourcegraph/amp.nvim',
})
require('amp').setup({ auto_start = true, log_level = "info" })# For automatic loading on startup
git clone https://github.com/sourcegraph/amp.nvim.git \
~/.local/share/nvim/site/pack/plugins/start/amp.nvim
# Or for optional loading (use :packadd amp.nvim to load)
git clone https://github.com/sourcegraph/amp.nvim.git \
~/.local/share/nvim/site/pack/plugins/opt/amp.nvimThen add to your init.lua:
require('amp').setup({ auto_start = true, log_level = "info" })Once installed, run amp --ide.
Check the health of the plugin by running
:checkhealth ampor to run all healthchecks run:checkhealth
The plugin provides a simple send_message function that you can use to create your own commands and workflows. Here are two example commands you can add to your configuration, one to send a quick message, and one to send the contents of a buffer (useful for drafting longer messages):
-- Send a quick message to the agent
vim.api.nvim_create_user_command("AmpSend", function(opts)
local message = opts.args
if message == "" then
print("Please provide a message to send")
return
end
local amp_message = require("amp.message")
amp_message.send_message(message)
end, {
nargs = "*",
desc = "Send a message to Amp",
})
-- Send entire buffer contents
vim.api.nvim_create_user_command("AmpSendBuffer", function(opts)
local buf = vim.api.nvim_get_current_buf()
local lines = vim.api.nvim_buf_get_lines(buf, 0, -1, false)
local content = table.concat(lines, "\n")
local amp_message = require("amp.message")
amp_message.send_message(content)
end, {
nargs = "?",
desc = "Send current buffer contents to Amp",
})
-- Add selected text directly to prompt
vim.api.nvim_create_user_command("AmpPromptSelection", function(opts)
local lines = vim.api.nvim_buf_get_lines(0, opts.line1 - 1, opts.line2, false)
local text = table.concat(lines, "\n")
local amp_message = require("amp.message")
amp_message.send_to_prompt(text)
end, {
range = true,
desc = "Add selected text to Amp prompt",
})
-- Add file+selection reference to prompt
vim.api.nvim_create_user_command("AmpPromptRef", function(opts)
local bufname = vim.api.nvim_buf_get_name(0)
if bufname == "" then
print("Current buffer has no filename")
return
end
local relative_path = vim.fn.fnamemodify(bufname, ":.")
local ref = "@" .. relative_path
if opts.line1 ~= opts.line2 then
ref = ref .. "#L" .. opts.line1 .. "-" .. opts.line2
elseif opts.line1 > 1 then
ref = ref .. "#L" .. opts.line1
end
local amp_message = require("amp.message")
amp_message.send_to_prompt(ref)
end, {
range = true,
desc = "Add file reference (with selection) to Amp prompt",
})Do you have a feature request or an idea? Submit an issue in this repo!
Uses stylua for general formatting, and lua-language-server for linting.
stylua .
nvim --headless --clean -c ':!lua-language-server --check .' -c 'qa'The plugin uses the same lockfile directory pattern as the main Amp repository:
- Windows & macOS:
~/.local/share/amp/ide - Linux:
$XDG_DATA_HOME/amp/ideor~/.local/share/amp/ide
You can override the data directory by setting the AMP_DATA_HOME environment variable for testing or custom setups.
The amp.nvim plugin logs to ~/.cache/nvim/amp.log.
Contributors should follow the Sourcegraph Community Code of Conduct.