Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information. update READMEs May 22, 2019

Vim/Neovim plugin for Kite



Requires Vim 8 or NeoVim.

Download Kite from During Kite's installation process, select Vim and/or Neovim in the list of editors and Kite will install this plugin for you.

Kite will also keep the plugin up to date automatically.

Learn more about Kite for Vim.

Kite Copilot

As you edit your code in Vim/Neovim, the Kite Copilot will show completions, examples, and docs for the code under the cursor.


Kite's ranked completions are integrated with Vim's insert-mode completion, specifically the user-defined completion. Kite shows normal completions or signature-completions as appropriate for the cursor position.

By default Kite's completions will show up automatically as you type. You can opt out via:

let g:kite_auto_complete=0

You can manually invoke the completions in insert mode with <C-X><C-U>. See :h i_CTRL-X_CTRL-U for details.

Normally you insert the currently selected completion option with <C-y>. If you'd like to use <Tab> instead / as well, add this to your vimrc:

let g:kite_tab_complete=1

You can configure how the completions behave with &completeopt. The plugin configures &completeopt as follows if and only if you haven't configured it yourself:

set completeopt-=menu
set completeopt+=menuone   " show the popup menu even when there is only 1 match
set completeopt-=longest   " don't insert the longest common text
set completeopt-=preview   " don't show preview window
set completeopt+=noinsert  " don't insert any text until user chooses a match
set completeopt-=noselect  " select first match

Make sure you have either menu or menuone otherwise you won't see any completions.

If you set longest together with menu or menuone, you will need to type CTRL-L when the pop-up menu is showing to insert the longest common text. See :help completeopt for details.

To see documentation in the preview window for each completion option, copy all the lines above into your vimrc and change the preview line to:

set completeopt+=preview

To have the preview window automatically closed once a completion has been inserted:

autocmd CompleteDone * if !pumvisible() | pclose | endif

We also recommend:

set belloff+=ctrlg  " if vim beeps during completion


Kite can show how other people used the signature you are using. By default this is off to save space.

To turn it on: :KiteShowPopularPatterns.

To turn it off: :KiteHidePopularPatterns.


Press K when the cursor is on a keyword to view its documentation in Kite Copilot.

If you have mapped K already, the plugin won't overwrite your mapping.

You can set an alternative mapping, e.g. to gK, like this:

nmap <silent> <buffer> gK <Plug>(kite-docs)

By default you need to type K (or whatever you have mapped to <Plug>(kite-docs)) each time you want to see documentation for the keyword under the cursor. To have the documentation continually update itself as you move from keyword to keyword:

let g:kite_documentation_continual=1


  • KiteDocsAtCursor - show documentation for the keyword under the cursor.
  • KiteOpenCopilot - open the Kite Copilot and focus on it.
  • KiteGeneralSettings - open Kite's settings in the Copilot.
  • KitePermissions - open Kite's permission settings in the Copilot.
  • KiteHelp - show overview documentation.
  • KiteEnableAutoStart - start Kite automatically when Vim starts.
  • KiteDisableAutoStart - do not start Kite automatically when Vim starts.


Add %{kite#statusline()} to your statusline to get an indicator of what Kite is doing. If you don't have a status line, this one matches the default when &ruler is set:

set statusline=%<%f\ %h%m%r%{kite#statusline()}%=%-14.(%l,%c%V%)\ %P
set laststatus=2  " always display the status line


Use let g:kite_log=1 to switch on logging. Logs are written to kite-vim.log in Vim's current working directory.

About Kite

Kite is built by a team in San Francisco devoted to making programming easier and more enjoyable for all. Follow Kite on Twitter and get the latest news and programming tips on the Kite Blog. Kite has been featured in Wired, VentureBeat, The Next Web, and TechCrunch.

You can’t perform that action at this time.