azorng/goose.nvim

github

ai

257

5

2

10

CREATED

2025-03-01

UPDATED

7 days ago

---

🪿 goose.nvim

seamless neovim integration with goose - work with a powerful AI agent without leaving your editor

✨ Description

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.

📑 Table of Contents

• Requirements
• Installation
• Configuration
• Usage
• Context
• Setting up goose

📋 Requirements

• Goose CLI installed and available (see Setting up goose below)

🚀 Installation

Install the plugin with your favorite package manager. See the Configuration section below for customization options.

With lazy.nvim

{
  "azorng/goose.nvim",
  config = function()
    require("goose").setup({})
  end,
  dependencies = {
    "nvim-lua/plenary.nvim",
    {
      "MeanderingProgrammer/render-markdown.nvim",
      opts = {
        anti_conceal = { enabled = false },
      },
    }
  },
}

⚙️ Configuration

-- Default configuration with all available options
require('goose').setup({
  prefered_picker = nil,                     -- 'telescope', 'fzf', 'mini.pick', 'snacks', if nil, it will use the best available picker
  default_global_keymaps = true,             -- If false, disables all default global keymaps
  keymap = {
    global = {
      toggle = '<leader>gg',                 -- Open goose. Close if opened
      open_input = '<leader>gi',             -- Opens and focuses on input window on insert mode
      open_input_new_session = '<leader>gI', -- Opens and focuses on input window on insert mode. Creates a new session
      open_output = '<leader>go',            -- Opens and focuses on output window
      toggle_focus = '<leader>gt',           -- Toggle focus between goose and last window
      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
      goose_mode_chat = '<leader>gmc',       -- Set goose mode to `chat`. (Tool calling disabled. No editor context besides selections)
      goose_mode_auto = '<leader>gma',       -- Set goose mode to `auto`. (Default mode with full agent capabilities)
      configure_provider = '<leader>gp',     -- Quick provider and model switch from predefined list
      diff_open = '<leader>gd',              -- Opens a diff tab of a modified file since the last goose prompt
      diff_next = '<leader>g]',              -- Navigate to next file diff
      diff_prev = '<leader>g[',              -- Navigate to previous file diff
      diff_close = '<leader>gc',             -- Close diff view tab and return to normal editing
      diff_revert_all = '<leader>gra',       -- Revert all file changes since the last goose prompt
      diff_revert_this = '<leader>grt',      -- Revert current file changes since the last goose prompt
    },
    window = {
      submit = '<cr>',                     -- Submit prompt (normal mode)
      submit_insert = '<cr>',              -- Submit prompt (insert mode)
      close = '<esc>',                     -- Close UI windows
      stop = '<C-c>',                      -- Stop goose while it is running
      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. See File Mentions section
      toggle_pane = '<tab>',               -- Toggle between input and output panes
      prev_prompt_history = '<up>',        -- Navigate to previous prompt in history
      next_prompt_history = '<down>'       -- Navigate to next prompt in history
    }
  },
  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)
    layout = "right",                      -- Options: "center" or "right"
    floating_height = 0.8,                 -- Height as percentage of editor height for "center" layout
    display_model = true,                  -- Display model name on top winbar
    display_goose_mode = true              -- Display mode on top winbar: auto|chat
  },
  providers = {
    --[[
    Define available providers and their models for quick model switching
    anthropic|azure|bedrock|databricks|google|groq|ollama|openai|openrouter
    Example:
    openrouter = {
      "anthropic/claude-3.5-sonnet",
      "openai/gpt-4.1",
    },
    ollama = {
      "cogito:14b"
    }
    --]]
  }
})

🧰 Usage

Available Actions

The plugin provides the following actions that can be triggered via keymaps, commands, or the Lua API:

📝 Context

The following editor context is automatically captured and included in your conversations.

Adding more files to context through file mentions

You can reference files in your project directly in your conversations with Goose. This is useful when you want to ask about or provide context about specific files. Type @ in the input window to trigger the file picker. Supported pickers include fzf-lua, telescope, mini.pick, snacks

🔧 Setting up goose

If you're new to goose:

1. What is Goose?

   • Goose is an AI agent developed by Block (the company behind Square, Cash App...)
   • It offers powerful AI assistance with extensible configurations such as LLMs and MCP servers

2. Installation:

   • Visit Install Goose for installation and configuration instructions
   • Ensure the goose command is available after installation

3. Configuration:

   • Run goose configure to set up your LLM provider (Claude 3.7 Sonnet is recommended)