codeium.vim

Free, ultrafast Copilot alternative for Vim and Neovim

Codeium autocompletes your code with AI in all major IDEs. This repository contains the implementation of the Codeium plugin for Vim and Neovim. Check out our playground if you want to quickly try out Codeium online.

Contributions are welcome! Feel free to submit pull requests and issues related to the plugin.

🚀 Getting started

Install Vim (at least 9.0.0185) or Neovim (at least 0.6)
Install Exafunction/codeium.vim using your vim plugin manager of choice, or manually. See Installation Options below.
Run :Codeium Auth to set up the plugin and start using Codeium.

You can run :help codeium for a full list of commands and configuration options.

🛠️ Configuration

🖥️ For Vim users

Codeium can be disabled for particular filetypes by setting the g:codeium_filetypes variable in your vim config file (vimrc/init.vim):

let g:codeium_filetypes = {
    \ "bash": v:false,
    \ "typescript": v:true,
    \ }

Codeium is enabled by default for most filetypes.

You can also disable codeium by default with the g:codeium_enabled variable:

let g:codeium_enabled = v:false

For a full list of configuration options you can run :help codeium.

💻 For Neovim users

You can use the following Lua code to invoke the Vimscript function for autocompletion by this plugin:

vim.fn["codeium#Accept"]()

Since this function returns an expression, we need to specify it explicitly using { expr = true }. Here is a working example for both wbthomason/packer.nvim and folke/lazy.nvim:

-- Remove the `use` here if you're using folke/lazy.nvim.
use {
  'Exafunction/codeium.vim',
  config = function ()
    -- Change '<C-g>' here to any keycode you like.
    vim.keymap.set('i', '<C-g>', function ()
      return vim.fn['codeium#Accept']()
    end, { expr = true })
  end
}

(Make sure that you ran :Codeium Auth after installation.)

💾 Installation Options

🔌 vim-plug

Plug 'Exafunction/codeium.vim'

📦 Vundle

Plugin 'Exafunction/codeium.vim'

📦 packer.nvim:

use 'Exafunction/codeium.vim'

💪 Manual

🖥️ Vim

Run the following. On windows, you can replace ~/.vim with $HOME/vimfiles:

git clone https://github.com/Exafunction/codeium.vim ~/.vim/pack/Exafunction/start/codeium.vim

💻 Neovim

Run the following. On windows, you can replace ~/.config with $HOME/AppData/Local:

git clone https://github.com/Exafunction/codeium.vim ~/.config/nvim/pack/Exafunction/start/codeium.vim

nanderoo / codeium.vim