neocodeium

neocodeium copied to clipboard

⚡ Free AI completion plugin powered by codeium ⚡

[!Note] Requires neovim 0.10+ to work.

📦 Installation

Here’s an example for 💤lazy plugin manager. If you're using a different plugin manager, please refer to its documentation for installation instructions.

-- add this to the file where you setup your other plugins:
{
  "monkoose/neocodeium",
  event = "VeryLazy",
  config = function()
    local neocodeium = require("neocodeium")
    neocodeium.setup()
    vim.keymap.set("i", "<A-f>", neocodeium.accept)
  end,
}

Now you can use Alt-f in insert mode to accept codeium suggestions.

Note: To obtain an API token, you’ll need to run :NeoCodeium auth.

🚀 Usage

📒 API

In addition to the already mentioned accept() function, the plugin also provides a few others:

local neocodeium = require("neocodeium")

-- Accepts the suggestion
neocodeium.accept()

-- Accepts only part of the suggestion if the full suggestion doesn't make sense
neocodeium.accept_word()
neocodeium.accept_line()

-- Clears the current suggestion
neocodeium.clear()

-- Cycles through suggestions by `n` (1 by default) items. Use a negative value to cycle in reverse order
neocodeium.cycle(n)

-- Same as `cycle()`, but also tries to show a suggestion if none is visible.
-- Mostly useful with the enabled `manual` option
neocodeium.cycle_or_complete(n)

-- Checks if a suggestion's virtual text is visible or not (useful for some complex mappings)
neocodeium.visible()

⌨️ Keymaps

NeoCodeium doesn’t enforce any keymaps, which means you’ll need to add them yourself. While codeium.vim and copilot.vim set the <Tab> keymap as the default key for accepting a suggestion, but <Tab> has some downsides to consider (but nothing stops you from using it):

• Risk of Interference: There’s a high chance of it conflicting with other plugins (such as snippets, nvim-cmp, etc.).
• Not Consistent: It doesn’t work in the :h command-line-window.
• Indentation Challenges: It is harder to indent with the tab at the start of a line.

Suggested keymaps:

vim.keymap.set("i", "<A-f>", function()
    require("neocodeium").accept()
end)
vim.keymap.set("i", "<A-w>", function()
    require("neocodeium").accept_word()
end)
vim.keymap.set("i", "<A-a>", function()
    require("neocodeium").accept_line()
end)
vim.keymap.set("i", "<A-e>", function()
    require("neocodeium").cycle_or_complete()
end)
vim.keymap.set("i", "<A-r>", function()
    require("neocodeium").cycle_or_complete(-1)
end)
vim.keymap.set("i", "<A-c>", function()
    require("neocodeium").clear()
end)

🔤 Commands

NeoCodeium provides :NeoCodeium user command, which has some useful actions:

• :NeoCodeium auth - authenticates the user and saves the API token.
• :NeoCodeium disable - disables NeoCodeium completion.
• :NeoCodeium enable - enables NeoCodeium completion.
• :NeoCodeium toggle - toggles NeoCodeium completion.
• :NeoCodeium disable_buffer - disables NeoCodeium completion in the current buffer.
• :NeoCodeium enable_buffer - enables NeoCodeium completion in the current buffer.
• :NeoCodeium open_log - opens new tab with the log output. More information is in the logging section.
• :NeoCodeium restart - restarts Codeium server (useful when server stops responding for any reason).

You can also use such commands in your lua scripts by calling require("neocodeium.commands").<command_name>().

🎨 Highlight groups

NeoCodeium offers a couple of highlight groups. Feel free to adjust them to your preference and to match your chosen color scheme:

• NeoCodeiumSuggestion - virtual text color of the plugin suggestions (default: #808080)
• NeoCodeiumLabel - color of the label that indicates the number of suggestions (default: inverted DiagnosticInfo)

using alongside nvim-cmp

If you are using NeoCodeium with manual = false (it is default), it is useful to set nvim-cmp to manual completion and clear NeoCodeium suggestions on opening nvim-cmp popup menu. You can achieve this with following code in the place where nvim-cmp is configured:

local cmp = require("cmp")
local neocodeium = require("neocodeium")
local commands = require("neocodeium.commands")

cmp.event:on("menu_opened", function()
    commands.disable()
    neocodeium.clear()
end)

cmp.event:on("menu_closed", function()
    commands.enable()
end)

cmp.setup({
    completion = {
        autocomplete = false,
    },
})

📄 Logging

While running NeoCodeium logs some messages into a temporary file. It can be viewed with the :NeoCodeium open_log command. By default only errors and warnings are logged.

You can set the logging level to one of trace, debug, info, warn or error by exporting the NEOCODEIUM_LOG_LEVEL environment variable.

Example:

NEOCODEIUM_LOG_LEVEL=info nvim

⚒️ Setup

NeoCodeium comes with the following default options:

-- NeoCodeium Configuration
require("neocodeium").setup({
  -- Enable NeoCodeium on startup
  enabled = true,
  -- Path to a custom Codeium server binary (you can download one from:
  -- https://github.com/Exafunction/codeium/releases)
  bin = nil,
  -- When set to `true`, autosuggestions are disabled.
  -- Use `require'neodecodeium'.cycle_or_complete()` to show suggestions manually
  manual = false,
  -- Information about the API server to use
  server = {
    -- API URL to use (for Enterprise mode)
    api_url = nil,
    -- Portal URL to use (for registering a user and downloading the binary)
    portal_url = nil,
  },
  -- Set to `false` to disable showing the number of suggestions label
  -- at the line column
  show_label = true,
  -- Set to `true` to enable suggestions debounce
  debounce = false,
  -- Maximum number of lines parsed from loaded buffers (current buffer always fully parsed)
  -- Set to `0` to disable parsing non-current buffers (may lower suggestion quality)
  -- Set it to `-1` to parse all lines
  max_lines = 10000,
  -- Set to `true` to disable some non-important messages, like "NeoCodeium: server started..."
  silent = false,
  -- Set to `false` to disable suggestions in buffers with specific filetypes
  filetypes = {
    help = false,
    gitcommit = false,
    gitrebase = false,
    ["."] = false,
  },
})

🚗 Roadmap

• [x] Add vimdoc help
• [x] Add the command to open buffer with the log output
• [x] Add :checkhealth
• [ ] Add support for Codeium Chat

💐 Credits

• codeium.vim - The main source for understanding how to use Codeium.

🌟 License

MIT license