blink-copilot

⚙️ Configurable GitHub Copilot blink.cmp source

Table of Contents

• 📋 Requirements
• 🌟 Features
• 🥘 Recipes
• ⚙️ Configuration
  • max_completions
  • max_attempts
  • kind_name
  • kind_icon
  • kind_hl
  • debounce
  • auto_refresh
• 📚 Frequently Asked Questions
• 🔄 Alternatives and Related Projects
• 🪪 License

📋 Requirements

• Neovim >= 0.9.0
• GitHub Copilot LSP Provider (choose one of the following)
  • copilot.vim - Official GitHub Copilot Vim/Neovim Plugin
  • copilot.lua - Third-party GitHub Copilot written in Lua

🌟 Features

1. Compliant with the blink.cmp async specification.
2. Automatically detects the LSP client during buffer switches.
3. Supports multiple completion candidates.
4. Refreshes Copilot suggestion items dynamically as the cursor moves.
5. Implemented entirely in Lua using the latest GitHub Copilot LSP APIs.
6. Offers an improved preview with auto-indentation for completion items.
7. Compatible with both copilot.lua and the official copilot.vim LSP providers.
8. Easily configurable icon and kind settings.

🥘 Recipes

Here are some example configuration for using blink-copilot with lazy.nvim.

blink-copilot + zbirenbaum/copilot.lua

{
  "zbirenbaum/copilot.lua",
  cmd = "Copilot",
  event = "InsertEnter",
  opts = {
    suggestion = { enabled = false },
    panel = { enabled = false },
    filetypes = {
      markdown = true,
      help = true,
    },
  },
},
{
  "saghen/blink.cmp",
  optional = true,
  dependencies = { "fang2hou/blink-copilot" },
  opts = {
    sources = {
      default = { "copilot" },
      providers = {
        copilot = {
          name = "copilot",
          module = "blink-copilot",
          score_offset = 100,
          async = true,
        },
      },
    },
  },
}

blink-copilot + github/copilot.vim

{
  "github/copilot.vim",
  cmd = "Copilot",
  event = "BufWinEnter",
  init = function()
    vim.g.copilot_no_maps = true
  end,
  config = function()
    -- Block the normal Copilot suggestions
    vim.api.nvim_create_augroup("github_copilot", { clear = true })
    vim.api.nvim_create_autocmd({ "FileType", "BufUnload", "BufEnter" }, {
      group = "github_copilot",
      callback = function(args)
        vim.fn["copilot#On" .. args.event]()
      end,
    })
  end,
},
{
  "saghen/blink.cmp",
  dependencies = { "fang2hou/blink-copilot" },
  opts = {
    sources = {
      default = { "copilot" },
      providers = {
        copilot = {
          name = "copilot",
          module = "blink-copilot",
          score_offset = 100,
          async = true,
        },
      },
    },
  },
}

With 💤 LazyVim copilot extra

blink-cmp-copilot ➡️ blink-copilot

-- Import copilot extra (you can also use `:LazyExtras` to install it)
{ import = "lazyvim.plugins.extras.ai.copilot" },

-- Source replacement
{
  "giuxtaposition/blink-cmp-copilot",
  enabled = false,
},
{
  "saghen/blink.cmp",
  dependencies = { "fang2hou/blink-copilot" },
  opts = {
    sources = {
      providers = {
        copilot = {
          module = "blink-copilot",
        },
      },
    },
  },
}

(Optional)copilot.lua ➡️ copilot.vim

{
  "zbirenbaum/copilot.lua",
  enabled = false,
},
{
  "github/copilot.vim",
  cmd = "Copilot",
  event = "BufWinEnter",
  init = function()
    vim.g.copilot_no_maps = true
  end,
  config = function()
    -- Block the normal Copilot suggestions
    vim.api.nvim_create_augroup("github_copilot", { clear = true })
    vim.api.nvim_create_autocmd({ "FileType", "BufUnload", "BufEnter" }, {
      group = "github_copilot",
      callback = function(args)
        vim.fn["copilot#On" .. args.event]()
      end,
    })
  end,
}

⚙️ Configuration

blink-copilot seamlessly integrates with both blink.cmp source options and Neovim plugin configurations. For most users, simply configuring the options within blink options sources.provider.copilot.opts is sufficient.

Explore the configuration in detail

{
  "saghen/blink.cmp",
  optional = true,
  dependencies = {
    "fang2hou/blink-copilot",
    opts = {
      max_completions = 1,  -- Global default for max completions
      max_attempts = 2,     -- Global default for max attempts
    }
  },
  opts = {
    sources = {
      default = { "copilot" },
      providers = {
        copilot = {
          name = "copilot",
          module = "blink-copilot",
          score_offset = 100,
          async = true,
          opts = {
            -- Local options override global ones
            max_completions = 3,  -- Override global max_completions

            -- Final settings:
            -- * max_completions = 3
            -- * max_attempts = 2
            -- * all other options are default
          }
        },
      },
    },
  },
}

---

Here is the default configuration for blink-copilot:

{
  max_completions = 3,
  max_attempts = 4,
  kind_name = "Copilot", ---@type string | false
  kind_icon = " ", ---@type string | false
  kind_hl = false, ---@type string | false
  debounce = 200, ---@type integer | false
  auto_refresh = {
    backward = true,
    forward = true,
  },
}

max_completions

Maximum number of completions to show.

Note

Sometimes Copilot do not provide any completions, even you set max_completions to a large number. This is a limitation of Copilot itself, not the plugin.

Default: 3

max_attempts

Maximum number of attempts to fetch completions.

Note

Each attempt will fetch 0 ~ 10 completions. Considering the possibility of failure, it is generally recommended to set it to max_completions+1.

Default: 4

kind_name

Specifies the type of completion item to display. Some distros may automatically set icon from the kind_name.

Set to false to disable the kind_name in completion items.

Default: "Copilot"

kind_icon

Specifies the icon of completion item to display.

Set to false to disable the kind_icon in completion items.

Default: " " ()

kind_hl

Specifies the highlight group of completion item to display.

Set to false to disable the kind_hl in completion items.

Default: false

debounce

Note

Debounce is a feature that limits the number of requests sent to Copilot.
You can customize the debounce time in milliseconds or set it to false to disable it.

Important

If you disable debounce and enable auto_refresh, the copilot suggestion items will be refreshed every time the cursor moves.
Excessive refreshing may temporarily block your Copilot.

Default: 200

auto_refresh

Automatically refreshes the completion list when the cursor moves.

Note

If you enable backward, the completion list will be refreshed when the cursor moves backward. If you enable forward, the completion list will be refreshed when the cursor moves forward.

Default: { backward = true, forward = true }

📚 Frequently Asked Questions

The number of completions does not match my settings.

This is because the number of completions provided by Copilot is not fixed. The max_completions setting is only an upper limit, and the actual number of completions may be less than this value.

What's the difference between blink-copilot and blink-cmp-copilot?

• Completion Preview is now correctly deindented.
• Support both copilot.lua and copilot.vim as a backend.
• Support multiple completions, and it is configurable.
• LSP interaction no longer relies on copilot.lua, ensuring improved performance and compliance with the latest official LSP API specifications.
• Auto refresh copilot suggestion items when cursor moves.

The completion isn't working after restarting Copilot. What should I do?

The Copilot plugin doesn't automatically attach the new LSP client to buffers. To resolve this, manually reopen your current buffer to attach the LSP client. blink-copilot will automatically detect the new client and resume completions.

Why aren't blink completions showing up?

Blink intentionally pauses completions during macro recording. If you see recording @x in your statusline, press q to stop recording.

🔄 Alternatives and Related Projects

• hrsh7th/cmp-copilot - The copilot.vim source for nvim-cmp.
• zbirenbaum/copilot-cmp - The copilot.lua source for nvim-cmp.
• giuxtaposition/blink-cmp-copilot - The copilot.lua source for blink.cmp.

🪪 License

MIT