Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

sidekick

URL: https://github.com/folke/sidekick.nvim/

Maintainers: Austin Horstman


A Neovim plugin for using AI coding CLIs from the editor.

Sidekick’s NES feature requires the Copilot language server. Enable either plugins.copilot-lua.enable or lsp.servers.copilot.enable, or disable NES in plugins.sidekick.settings.opts.nes.enabled.

Sidekick supports several external CLI tools, but nixvim does not enable them automatically. Enable the tools you use explicitly, for example with dependencies.claude-code.enable, dependencies.copilot.enable, dependencies.gemini.enable, or dependencies.opencode.enable, or add the desired packages to your environment yourself.

plugins.sidekick.enable

Whether to enable sidekick.

Type: boolean

Default:

false

Example:

true

Declared by:

plugins.sidekick.package

The sidekick package to use.

Type: package

Default:

pkgs.vimPlugins.sidekick-nvim

Declared by:

plugins.sidekick.autoLoad

Whether to automatically load sidekick when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example:

false

Declared by:

plugins.sidekick.callSetup

Whether to generate the standard require('sidekick').setup(...) call for this plugin.

By default, this follows the plugin’s built-in behavior. Set this to false to disable the generated setup call, or to true to force it even when the plugin would only call it conditionally.

Type: null or boolean

Default:

null

Declared by:

plugins.sidekick.settings

Options provided to the require('sidekick').setup function.

Type: lua value

Default:

{ }

Example:

{
  cli = {
    mux = {
      backend = "zellij";
      enabled = true;
    };
  };
}

Declared by: