🤖 sidekick.nvim

sidekick.nvim is your Neovim AI sidekick that integrates Copilot LSP's "Next Edit Suggestions" with a built-in terminal for any AI CLI. Review and apply diffs, chat with AI assistants, and streamline your coding, without leaving your editor.

✨ Features

• 🤖 Next Edit Suggestions (NES) powered by Copilot LSP

  • 🪄 Automatic Suggestions: Fetches suggestions automatically when you pause typing or move the cursor.
  • 🎨 Rich Diffs: Visualizes changes with inline and block-level diffs, featuring Treesitter-based syntax highlighting with granular diffing down to the word or character level.
  • 🧭 Hunk-by-Hunk Navigation: Jump through edits to review them one by one before applying.
  • 📊 Statusline Integration: Shows Copilot LSP's status, request progress, and preview text in your statusline.

• 💬 Integrated AI CLI Terminal

  • 🚀 Direct Access to AI CLIs: Interact with your favorite AI command-line tools without leaving Neovim.
  • 📦 Pre-configured for Popular Tools: Out-of-the-box support for Claude, Gemini, Grok, Codex, Copilot CLI, and more.
  • ✨ Context-Aware Prompts: Automatically include file content, cursor position, and diagnostics in your prompts.
  • 📝 Prompt Library: A library of pre-defined prompts for common tasks like explaining code, fixing issues, or writing tests.
  • 🔄 Session Persistence: Keep your CLI sessions alive with tmux and zellij integration.
  • 📂 Automatic File Watching: Automatically reloads files in Neovim when they are modified by AI tools.

• 🔌 Extensible and Customizable

  • ⚙️ Flexible Configuration: Fine-tune every aspect of the plugin to your liking.
  • 🧩 Plugin-Friendly API: A rich API for integrating with other plugins and building custom workflows.
  • 🎨 Customizable UI: Change the appearance of diffs, signs, and more.

📋 Requirements

• Neovim >= 0.11.2 or newer
• The official copilot-language-server LSP server, enabled with vim.lsp.enable. Can be installed in multiple ways:
  1. install using npm or your OS's package manager
  2. install with mason-lspconfig.nvim
  3. copilot.lua and copilot.vim both bundle the LSP Server in their plugin.
• A working lsp/copilot.lua configuration.
  • TIP: Included in nvim-lspconfig
• snacks.nvim for better prompt/tool selection (optional)
• nvim-treesitter-textobjects (main branch) for {function} and {class} context variables (optional)
• AI cli tools, such as Codex, Claude, Copilot, Gemini, … (optional) see the 🤖 AI CLI Integration section for details.
• lsof and ps are used on Unix-like systems to detect running AI CLI tool sessions. (optional, but recommended)

🚀 Quick Start