License

windsurf.nvim

Native Windsurf plugin for Neovim.

Contributing

Feel free to create an issue/PR if you want to see anything else implemented.

Screenshots

Completion in Action

Installation

packer.nvim

use {
    "Exafunction/windsurf.nvim",
    requires = {
        "nvim-lua/plenary.nvim",
        "hrsh7th/nvim-cmp",
    },
    config = function()
        require("codeium").setup({
        })
    end
}

lazy.nvim

{
    "Exafunction/windsurf.nvim",
    dependencies = {
        "nvim-lua/plenary.nvim",
        "hrsh7th/nvim-cmp",
    },
    config = function()
        require("codeium").setup({
        })
    end
},

Usage

After installation and configuration, you will need to authenticate with Windsurf. This can be done by running :Codeium Auth, copying the token from your browser and pasting it into API token request.

To use Windsurf Chat, execute the :Codeium Chat command. The chat will be opened in your default browser using the xdg-open command.

You can globaly enable or disable Codeium Completion with :Codeium Toggle command.

Options

config_path: the path to the config file, used to store the API key.
bin_path: the path to the directory where the Windsurf server will be downloaded to.
api: information about the API server to use:
- host: the hostname. Example: "codeium.example.com". Required when using enterprise mode
- port: the port. Defaults to 443
- path: the path prefix to the API server. Default for enterprise: "/_route/api_server"
- portal_url: the portal URL to use (for enterprise mode). Defaults to host:port
enterprise_mode: enable enterprise mode
detect_proxy: enable or disable proxy detection
enable_chat: enable chat functionality
enable_cmp_source: defaults to true. Set false to disable registering a cmp source
virtual_text: configuration for showing completions in virtual text
- enabled: defaults to false. Set true to enable the virtual text feature
- filetypes: A mapping of filetype to true or false, to enable virtual text
- default_filetype_enabled: Whether to enable virtual text of not for types not listed in filetypes.
- manual: Set true to only trigger Codeium using a manual Lua function call
- idle_delay: defaults to 75. Time in ms to wait before requesting completions after typing stops.
- virtual_text_priority: defaults to 65535. Priority of the virtual text
- map_keys: defaults to true. Set false to not set any key bindings for completions
- accept_fallback: Emulate pressing this key when using the accept key binding but there is no completion. Defaults to "\t"
- key_bindings: key bindings for accepting and cycling through completions
  - accept: key binding for accepting a completion, default is <Tab>
  - accept_word: key binding for accepting only the next word, default is not set
  - accept_line: key binding for accepting only the next line, default is not set
  - clear: key binding for clearing the virtual text, default is not set
  - next: key binding for cycling to the next completion, default is <M-]>
  - prev: key binding for cycling to the previous completion, default is <M-[>
workspace_root:
- use_lsp: Use Neovim's LSP support to find the workspace root, if possible.
- paths: paths to files that indicate a workspace root when not using the LSP support
- find_root: An optional function that the plugin will call to find the workspace root.
tools: paths to binaries used by the plugin:
- uname: not needed on Windows, defaults given.
- uuidgen
- curl:
- gzip: not needed on Windows, default implemenation given using powershell.exe Expand-Archive instead
- language_server: The path to the language server downloaded from the official source.
wrapper: the path to a wrapper script/binary that is used to execute any binaries not listed under tools. This is primarily useful for NixOS, where a FHS wrapper can be used for the downloaded codeium server.

nvim-cmp

After calling setup, this plugin will register a source in nvim-cmp. nvim-cmp can then be set up to use this source using the sources configuration:

cmp.setup({
    -- ...
    sources = {
        -- ...
        { name = "codeium" }
    }
})

If you are seeing the codeium source as unused in :CmpStatus, make sure that nvim-cmp setup happens before the windsurf.nvim setup.

To set a symbol for windsurf using lspkind, use the Codeium keyword. Example:

cmp.setup({
    -- ...
    formatting = {
        format = require('lspkind').cmp_format({
            mode = "symbol",
            maxwidth = 50,
            ellipsis_char = '...',
            symbol_map = { Codeium = "", }
        })
    }
})

blink.cmp

Configuration example for blink.cmp:

{
  'saghen/blink.cmp',
  dependencies = {
    {
      'Exafunction/codeium.nvim',
    },
  },
  opts = {
    sources = {
      default = { 'lsp', 'path', 'snippets', 'buffer', 'codeium' },
      providers = {
        codeium = { name = 'Codeium', module = 'codeium.blink', async = true },
      },
    },
  },
}

Virtual Text

The plugin supports showing completions in virtual text. Set virtual_text.enabled in the options to true to enable it.

require("codeium").setup({
    -- Optionally disable cmp source if using virtual text only
    enable_cmp_source = false,
    virtual_text = {
        enabled = true,

        -- These are the defaults

        -- Set to true if you never want completions to be shown automatically.
        manual = false,
        -- A mapping of filetype to true or false, to enable virtual text.
        filetypes = {},
        -- Whether to enable virtual text of not for filetypes not specifically listed above.
        default_filetype_enabled = true,
        -- How long to wait (in ms) before requesting completions after typing stops.
        idle_delay = 75,
        -- Priority of the virtual text. This usually ensures that the completions appear on top of
        -- other plugins that also add virtual text, such as LSP inlay hints, but can be modified if
        -- desired.
        virtual_text_priority = 65535,
        -- Set to false to disable all key bindings for managing completions.
        map_keys = true,
        -- The key to press when hitting the accept keybinding but no completion is showing.
        -- Defaults to \t normally or <c-n> when a popup is showing. 
        accept_fallback = nil,
        -- Key bindings for managing completions in virtual text mode.
        key_bindings = {
            -- Accept the current completion.
            accept = "<Tab>",
            -- Accept the next word.
            accept_word = false,
            -- Accept the next line.
            accept_line = false,
            -- Clear the virtual text.
            clear = false,
            -- Cycle to the next completion.
            next = "<M-]>",
            -- Cycle to the previous completion.
            prev = "<M-[>",
        }
    }
})

Virtual Text Keybindings

The plugin defines a number of key bindings for managing completion in virtual text mode. You can override these by setting virtual_text.key_bindings. If you don't want any key bindings, set virtual_text.map_keys to false, or you can set specific bindings to false.

When manual mode is enabled, you can call any of these functions to show completions:

-- Request completions immediately.
require('codeium.virtual_text').complete()

-- Request a completion, or cycle to the next if we already have some
require('codeium.virtual_text').cycle_or_complete()

-- Complete only after idle_delay has passed with no other calls to debounced_complete().
require('codeium.virtual_text').debounced_complete()

Virtual Text Filetypes

You can set the filetypes and default_filetype_enabled options in the virtual_text table to configure which filetypes should use virtual text.

require('codeium.virtual_text').setup({

Windsurf.nvim

Install / Use

README