Copilot

info

You can enable the extra with the :LazyExtras command. Plugins marked as optional will only be configured if they are installed.

Alternatively, you can add it to your lazy.nvim imports

lua/config/lazy.lua

require("lazy").setup({
  spec = {
    { "LazyVim/LazyVim", import = "lazyvim.plugins" },
    { import = "lazyvim.plugins.extras.ai.copilot" },
    { import = "plugins" },
  },
})

Below you can find a list of included plugins and their default settings.

caution

You don't need to copy the default settings to your config. They are only shown here for reference.

copilot.lua

copilot

Options

opts = {
  suggestion = {
    enabled = not vim.g.ai_cmp,
    auto_trigger = true,
    keymap = {
      accept = false, -- handled by nvim-cmp / blink.cmp
      next = "<M-]>",
      prev = "<M-[>",
    },
  },
  panel = { enabled = false },
  filetypes = {
    markdown = true,
    help = true,
  },
}

Full Spec

{
  "zbirenbaum/copilot.lua",
  cmd = "Copilot",
  build = ":Copilot auth",
  event = "InsertEnter",
  opts = {
    suggestion = {
      enabled = not vim.g.ai_cmp,
      auto_trigger = true,
      keymap = {
        accept = false, -- handled by nvim-cmp / blink.cmp
        next = "<M-]>",
        prev = "<M-[>",
      },
    },
    panel = { enabled = false },
    filetypes = {
      markdown = true,
      help = true,
    },
  },
}

copilot.lua

add ai_accept action

Options

opts = function()
  LazyVim.cmp.actions.ai_accept = function()
    if require("copilot.suggestion").is_visible() then
      LazyVim.create_undo()
      require("copilot.suggestion").accept()
      return true
    end
  end
end

Full Spec

{
  "zbirenbaum/copilot.lua",
  opts = function()
    LazyVim.cmp.actions.ai_accept = function()
      if require("copilot.suggestion").is_visible() then
        LazyVim.create_undo()
        require("copilot.suggestion").accept()
        return true
      end
    end
  end,
}

copilot-cmp

this will only be evaluated if nvim-cmp is enabled

Options

opts = {}

Full Spec

{
  "zbirenbaum/copilot-cmp",
  enabled = vim.g.ai_cmp, -- only enable if wanted
  opts = {},
  config = function(_, opts)
    local copilot_cmp = require("copilot_cmp")
    copilot_cmp.setup(opts)
    -- attach cmp source whenever copilot attaches
    -- fixes lazy-loading issues with the copilot cmp source
    LazyVim.lsp.on_attach(function()
      copilot_cmp._on_insert_enter({})
    end, "copilot")
  end,
  specs = {
    {
      "nvim-cmp",
      optional = true,
      ---@param opts cmp.ConfigSchema
      opts = function(_, opts)
        table.insert(opts.sources, 1, {
          name = "copilot",
          group_index = 1,
          priority = 100,
        })
      end,
    },
  },
}

blink-cmp-copilot

Options

opts = nil

Full Spec

{
  "giuxtaposition/blink-cmp-copilot",
  enabled = vim.g.ai_cmp, -- only enable if needed
  specs = {
    {
      "blink.cmp",
      optional = true,
      opts = {
        sources = {
          providers = {
            copilot = { name = "copilot", module = "blink-cmp-copilot" },
          },
          completion = {
            enabled_providers = { "copilot" },
          },
        },
      },
    },
  },
}

lualine.nvim (optional)

lualine

Options

opts = function(_, opts)
  table.insert(
    opts.sections.lualine_x,
    2,
    LazyVim.lualine.status(LazyVim.config.icons.kinds.Copilot, function()
      local clients = package.loaded["copilot"] and LazyVim.lsp.get_clients({ name = "copilot", bufnr = 0 }) or {}
      if #clients > 0 then
        local status = require("copilot.api").status.data.status
        return (status == "InProgress" and "pending") or (status == "Warning" and "error") or "ok"
      end
    end)
  )
end

Full Spec

{
  "nvim-lualine/lualine.nvim",
  optional = true,
  event = "VeryLazy",
  opts = function(_, opts)
    table.insert(
      opts.sections.lualine_x,
      2,
      LazyVim.lualine.status(LazyVim.config.icons.kinds.Copilot, function()
        local clients = package.loaded["copilot"] and LazyVim.lsp.get_clients({ name = "copilot", bufnr = 0 }) or {}
        if #clients > 0 then
          local status = require("copilot.api").status.data.status
          return (status == "InProgress" and "pending") or (status == "Warning" and "error") or "ok"
        end
      end)
    )
  end,
}

nvim-cmp (optional)

copilot cmp source

Options

opts = nil

Full Spec

{
  "nvim-cmp",
  optional = true,
  dependencies = { -- this will only be evaluated if nvim-cmp is enabled
    {
      "zbirenbaum/copilot-cmp",
      enabled = vim.g.ai_cmp, -- only enable if wanted
      opts = {},
      config = function(_, opts)
        local copilot_cmp = require("copilot_cmp")
        copilot_cmp.setup(opts)
        -- attach cmp source whenever copilot attaches
        -- fixes lazy-loading issues with the copilot cmp source
        LazyVim.lsp.on_attach(function()
          copilot_cmp._on_insert_enter({})
        end, "copilot")
      end,
      specs = {
        {
          "nvim-cmp",
          optional = true,
          ---@param opts cmp.ConfigSchema
          opts = function(_, opts)
            table.insert(opts.sources, 1, {
              name = "copilot",
              group_index = 1,
              priority = 100,
            })
          end,
        },
      },
    },
  },
}

nvim-cmp (optional)

Options

opts = function(_, opts)
  table.insert(opts.sources, 1, {
    name = "copilot",
    group_index = 1,
    priority = 100,
  })
end

Full Spec

{
  "nvim-cmp",
  optional = true,
  ---@param opts cmp.ConfigSchema
  opts = function(_, opts)
    table.insert(opts.sources, 1, {
      name = "copilot",
      group_index = 1,
      priority = 100,
    })
  end,
}

blink.cmp (optional)

blink.cmp

Options

opts = nil

Full Spec

{
  "saghen/blink.cmp",
  optional = true,
  dependencies = {
    {
      "giuxtaposition/blink-cmp-copilot",
      enabled = vim.g.ai_cmp, -- only enable if needed
      specs = {
        {
          "blink.cmp",
          optional = true,
          opts = {
            sources = {
              providers = {
                copilot = { name = "copilot", module = "blink-cmp-copilot" },
              },
              completion = {
                enabled_providers = { "copilot" },
              },
            },
          },
        },
      },
    },
  },
}

blink.cmp (optional)

Options

opts = {
  sources = {
    providers = {
      copilot = { name = "copilot", module = "blink-cmp-copilot" },
    },
    completion = {
      enabled_providers = { "copilot" },
    },
  },
}

Full Spec

{
  "blink.cmp",
  optional = true,
  opts = {
    sources = {
      providers = {
        copilot = { name = "copilot", module = "blink-cmp-copilot" },
      },
      completion = {
        enabled_providers = { "copilot" },
      },
    },
  },
}