seamless neovim integration with goose - work with a powerful AI agent without leaving your editor
This plugin provides a bridge between neovim and the goose AI agent, creating a chat interface while capturing editor context (current file, selections) to enhance your prompts. It maintains persistent sessions tied to your workspace, allowing for continuous conversations with the AI assistant similar to what tools like Cursor AI offer.
- Goose CLI installed and available (see Setting Up Goose CLI below)
This plugin is compatible with Goose CLI version 1.0.17.
Future versions may work but are not guaranteed. If you encounter issues with newer Goose CLI versions, please report them in the issues section.
Install the plugin with your favorite package manager. See the Configuration section below for customization options.
{
'azorng/goose.nvim',
branch = 'main',
config = function()
require('goose').setup({})
end,
dependencies = {
"nvim-lua/plenary.nvim",
{
"MeanderingProgrammer/render-markdown.nvim",
opts = {
anti_conceal = { enabled = false },
},
}
},
}-- Default configuration with all available options
require('goose').setup({
keymap = {
global = {
open_input = '<leader>gi', -- Opens and focuses on input window. Loads current buffer context
open_input_new_session = '<leader>gI', -- Opens and focuses on input window. Loads current buffer context. Creates a new session
open_output = '<leader>go', -- Opens and focuses on output window. Loads current buffer context
close = '<leader>gq', -- Close UI windows
toggle_fullscreen = '<leader>gf', -- Toggle between normal and fullscreen mode
select_session = '<leader>gs', -- Select and load a goose session
},
window = {
submit = '<cr>', -- Submit prompt
close = '<esc>', -- Close UI windows
stop = '<C-c>', -- Stop a running job
next_message = ']]', -- Navigate to next message in the conversation
prev_message = '[[', -- Navigate to previous message in the conversation
mention_file = '@' -- Pick a file and add to context
}
},
ui = {
window_width = 0.35, -- Width as percentage of editor width
input_height = 0.15, -- Input height as percentage of window height
fullscreen = false -- Start in fullscreen mode (default: false)
}
})The plugin provides the following actions that can be triggered via keymaps, commands, or the Lua API:
Note: Buffer context is only set by calling the open actions
| Action | Default keymap | Command | API Function |
|---|---|---|---|
| Open input window (current session) | <leader>gi |
:GooseOpenInput |
require('goose.api').open_input() |
| Open input window (new session) | <leader>gI |
:GooseOpenInputNewSession |
require('goose.api').open_input_new_session() |
| Open output window | <leader>go |
:GooseOpenOutput |
require('goose.api').open_output() |
| Close UI windows | <leader>gq |
:GooseClose |
require('goose.api').close() |
| Stop running job | <C-c> |
:GooseStop |
require('goose.api').stop() |
| Toggle fullscreen mode | <leader>gf |
:GooseToggleFullscreen |
require('goose.api').toggle_fullscreen() |
| Select and load session | <leader>gs |
:GooseSelectSession |
require('goose.api').select_session() |
| Pick a file and add to context | @ |
- | - |
| Run prompt (continue session) | - | :GooseRun <prompt> |
require('goose.api').run("prompt") |
| Run prompt (new session) | - | :GooseRunNewSession <prompt> |
require('goose.api').run_new_session("prompt") |
| Navigate to next message | ]] |
- | - |
| Navigate to previous message | [[ |
- | - |
If you're new to Goose CLI:
-
What is Goose CLI?
- Goose is an AI agent developed by Block (the company behind Square, Cash App...)
- It offers powerful AI assistance through a command-line interface
-
Installation:
- Visit Install Goose for installation instructions
- Ensure the
goosecommand is available after installation
-
Configuration:
- Run
goose configureto set up your provider (Claude 3.7 Sonnet is recommended)
- Run