Summary

sidekick.nvim enhances Neovim by integrating Copilot's "Next Edit Suggestions" (NES) and providing a built-in terminal for AI command-line interfaces. It targets Neovim users seeking to streamline AI-assisted coding workflows, enabling review and application of AI-generated code changes and interaction with various AI CLIs directly within the editor.

How It Works

The plugin leverages Copilot LSP for automatic "Next Edit Suggestions," presenting changes via rich, granular diffs (word/character level) with Treesitter syntax highlighting and allowing hunk-by-hunk navigation. It also features an integrated AI CLI terminal that supports popular tools like Claude, Gemini, and Grok. This terminal uses context-aware prompts, incorporating file content, cursor position, and diagnostics, and supports session persistence via tmux or zellij.

Quick Start & Requirements

• Installation: Typically via a plugin manager like lazy.nvim.
• Prerequisites: Neovim version 0.11.2 or newer. The official Copilot LSP server must be installed and enabled (e.g., via mason-lspconfig.nvim). A working lsp/copilot.lua configuration is also required.
• Setup: Run :checkhealth sidekick after installation. Integration with completion engines like blink.cmp or custom keymaps for <Tab> is recommended.

Highlighted Details

• Automatic "Next Edit Suggestions" powered by Copilot LSP with visual diffs.
• Granular diffing down to word or character level, with Treesitter syntax highlighting.
• Integrated AI CLI terminal supporting numerous tools (Claude, Gemini, Grok, Copilot CLI, etc.) with context-aware prompts.
• Session persistence for AI CLI tools using tmux or zellij backends.
• Statusline integration to display Copilot LSP status and progress.
• Extensible API for custom workflows and UI customization.

Maintenance & Community

No specific details regarding maintainers, community channels (like Discord/Slack), or roadmap were present in the provided README.

Licensing & Compatibility

Released under the MIT License. This license generally permits commercial use and integration into closed-source projects.

Limitations & Caveats

Requires a recent Neovim version (>= 0.11.2) and a properly configured Copilot LSP server. The AI CLI features depend on the user having the respective AI command-line tools installed and configured separately.