An autocompletion daemon for the Go programming language
Pull request Compare This branch is 37 commits ahead, 4 commits behind nsf:master.
Latest commit a5206a1 Oct 19, 2018
Failed to load latest commit information.
Godeps x Oct 19, 2018
_gccgo Run `go fmt` on `_gccgo/package.go`. Apr 10, 2014
_goremote Move things again, trying to suit GOPATH scheme. Mar 19, 2012
_testing Fix a bunch of type alias related autocompletion problems. Add tests. Oct 15, 2017
debian Remove 'goremote' from 'rules', it's for internal use only. Aug 7, 2011
docs Add a header to docs for server-side -debug mode section. Mar 27, 2014
emacs-company Keep "csv" formatter as is. Introduce new "csv-with-package" formatter. Aug 25, 2017
emacs Let user specify path to gocode bin Jun 26, 2017
nvim force symlink creation Apr 24, 2017
subl3 Fix diff bug, let's try a slightly different candidate displaying. Mar 3, 2016
vendor update fastmod&types for lookup module Oct 19, 2018
vim force symlink creation Apr 24, 2017
.gitignore Add gocode.exe to .gitignore Jun 18, 2015
LICENSE Add LICENSE. Gocode has MIT license. Aug 19, 2010 update gocode Jul 26, 2018
autocompletecontext.go update gomod dep Aug 3, 2018
autocompletefile.go Fix panic when parsing select statement case. Feb 26, 2017
client.go Add "ignore-case" and "partials" config options. Dec 30, 2017
config.go Add "class-filtering" config option. Jan 7, 2018
cursorcontext.go import to parser source Jul 27, 2018
decl.go fix bug test.0055 Aug 2, 2018
declcache.go clean vendor Aug 2, 2018
formatters.go Keep "csv" formatter as is. Introduce new "csv-with-package" formatter. Aug 25, 2017
gocode.go change unix daemon name Sep 2, 2018
os_posix.go Introduce config_dir(), move both to os_ specific files. Dec 26, 2012
os_windows.go Windows-specific config_dir/config_file implementation. Dec 26, 2012
package.go types: use fastmod to parse large Go module project (gohugoio/hugo) Oct 11, 2018
package_bin.go fix gc_bin_parser unknownTag Sep 21, 2018
package_text.go Add a feature I called "canonical aliases". Jun 30, 2017
package_types.go fix pkgwalk context Aug 1, 2018
pre_go17.go Add a bunch of build hacks. Feb 25, 2017
ripper.go Fix completion of functions using anonymous structs Oct 22, 2014
rpc.go Add "ignore-case" and "partials" config options. Dec 30, 2017
scope.go Attach package import path to scopes, pass it through to formatters Aug 16, 2017
server.go clean vendor Aug 2, 2018
type_alias_build_hack_18.go Fix it for real. Closes nsf#434. Mar 1, 2017
type_alias_build_hack_19.go Fix it for real. Closes nsf#434. Mar 1, 2017
utils.go List import paths for packages vendored only for the current package Feb 28, 2017

An autocompletion daemon for the Go programming language

Now support Go1.11 Go modules.

Gocode is a helper tool which is intended to be integrated with your source code editor, like vim, neovim and emacs. It provides several advanced capabilities, which currently includes:

  • Context-sensitive autocompletion

It is called daemon, because it uses client/server architecture for caching purposes. In particular, it makes autocompletions very fast. Typical autocompletion time with warm cache is 30ms, which is barely noticeable.

Also watch the demo screencast.

Gocode in vim

Gocode in emacs


  1. You should have a correctly installed Go compiler environment and your personal workspace ($GOPATH). If you have no idea what $GOPATH is, take a look here. Please make sure that your $GOPATH/bin is available in your $PATH. This is important, because most editors assume that gocode binary is available in one of the directories, specified by your $PATH environment variable. Otherwise manually copy the gocode binary from $GOPATH/bin to a location which is part of your $PATH after getting it in step 2.

    Do these steps only if you understand why you need to do them:

    export GOPATH=$HOME/goprojects

    export PATH=$PATH:$GOPATH/bin

  2. Then you need to get the appropriate version of the gocode, for 6g/8g/5g compiler you can do this:

    go get -u (-u flag for "update")

    Windows users should consider doing this instead:

    go get -u -ldflags -H=windowsgui

    That way on the Windows OS gocode will be built as a GUI application and doing so solves hanging window issues with some of the editors.

  3. Next steps are editor specific. See below.

Vim setup

Vim manual installation

Note: As of go 1.5 there is no $GOROOT/misc/vim script. Suggested installation is via vim-go plugin.

In order to install vim scripts, you need to fulfill the following steps:

  1. Install official Go vim scripts from $GOROOT/misc/vim. If you did that already, proceed to the step 2.

  2. Install gocode vim scripts. Usually it's enough to do the following:

    2.1. vim/ script does the following:

    mkdir -p "$HOME/.vim/autoload"
    mkdir -p "$HOME/.vim/ftplugin/go"
    cp "${0%/*}/autoload/gocomplete.vim" "$HOME/.vim/autoload"
    cp "${0%/*}/ftplugin/go/gocomplete.vim" "$HOME/.vim/ftplugin/go"

    2.2. Alternatively, you can create symlinks using script in order to avoid running after every gocode update. script does the following:

    cd "${0%/*}"
    mkdir -p "$HOME/.vim/autoload"
    mkdir -p "$HOME/.vim/ftplugin/go"
    ln -s "$ROOTDIR/autoload/gocomplete.vim" "$HOME/.vim/autoload/"
    ln -s "$ROOTDIR/ftplugin/go/gocomplete.vim" "$HOME/.vim/ftplugin/go/"
  3. Make sure vim has filetype plugin enabled. Simply add that to your .vimrc:

    filetype plugin on

  4. Autocompletion should work now. Use <C-x><C-o> for autocompletion (omnifunc autocompletion).

Using Vundle in Vim

Add the following line to your .vimrc:

Plugin 'nsf/gocode', {'rtp': 'vim/'}

And then update your packages by running :PluginInstall.

Using vim-plug in Vim

Add the following line to your .vimrc:

Plug 'nsf/gocode', { 'rtp': 'vim', 'do': '~/.vim/plugged/gocode/vim/' }

And then update your packages by running :PlugInstall.


Alternatively take a look at the vundle/pathogen friendly repo:

Neovim setup

Neovim manual installation

Neovim users should also follow Vim manual installation, except that you should goto gocode/nvim in step 2, and remember that, the Neovim configuration file is ~/.config/nvim/init.vim.

Using Vundle in Neovim

Add the following line to your init.vim:

Plugin 'nsf/gocode', {'rtp': 'nvim/'}

And then update your packages by running :PluginInstall.

Using vim-plug in Neovim

Add the following line to your init.vim:

Plug 'nsf/gocode', { 'rtp': 'nvim', 'do': '~/.config/nvim/plugged/gocode/nvim/' }

And then update your packages by running :PlugInstall.

Emacs setup

In order to install emacs script, you need to fulfill the following steps:

  1. Install auto-complete-mode

  2. Copy emacs/go-autocomplete.el file from the gocode source distribution to a directory which is in your 'load-path' in emacs.

  3. Add these lines to your .emacs:

    (require 'go-autocomplete)
    (require 'auto-complete-config)

Also, there is an alternative plugin for emacs using company-mode. See emacs-company/README for installation instructions.

If you're a MacOSX user, you may find that script useful: It helps you with setting up the right environment variables as Go and gocode require it. By default it pulls the PATH, but don't forget to add the GOPATH as well, e.g.:

(when (memq window-system '(mac ns))
  (exec-path-from-shell-copy-env "GOPATH"))


You can change all available options using gocode set command. The config file uses json format and is usually stored somewhere in ~/.config/gocode directory. On windows it's stored in the appropriate AppData folder. It's suggested to avoid modifying config file manually, do that using the gocode set command.

gocode set lists all options and their values.

gocode set <option> shows the value of that option.

gocode set <option> <value> sets the new value for that option.

  • propose-builtins

    A boolean option. If true, gocode will add built-in types, functions and constants to autocompletion proposals. Default: false.

  • lib-path

    A string option. Allows you to add search paths for packages. By default, gocode only searches $GOPATH/pkg/$GOOS_$GOARCH and $GOROOT/pkg/$GOOS_$GOARCH in terms of previously existed environment variables. Also you can specify multiple paths using ':' (colon) as a separator (on Windows use semicolon ';'). The paths specified by lib-path are prepended to the default ones.

  • autobuild

    A boolean option. If true, gocode will try to automatically build out-of-date packages when their source files are modified, in order to obtain the freshest autocomplete results for them. This feature is experimental. Default: false.

  • force-debug-output

    A string option. If is not empty, gocode will forcefully redirect the logging into that file. Also forces enabling of the debug mode on the server side. Default: "" (empty).

  • package-lookup-mode

    A string option. If go, use standard Go package lookup rules. If gb, use gb-specific lookup rules. See for details. Default: go.

  • close-timeout

    An integer option. If there have been no completion requests after this number of seconds, the gocode process will terminate. Defaults to 1800 (30 minutes).

  • unimported-packages

    A boolean option. If set to true, gocode will try to import certain known packages automatically for identifiers which cannot be resolved otherwise. Currently only a limited set of standard library packages are supported. Default: false.

  • partials

    A boolean option. If set to false, gocode will not filter autocompletion results based on entered prefix before the cursor. Instead it will return all available autocompletion results viable for a given context. Whether this option is set to true or false, gocode will return a valid prefix length for output formats which support it. Setting this option to a non-default value may result in editor misbehaviour. Default: true.

  • ignore-case

    A boolean option. If set to true, gocode will perform case-insensitive matching when doing prefix-based filtering. Default: false.

  • class-filtering

    A boolean option. Enables or disables gocode's feature where it performs class-based filtering if partial input matches corresponding class keyword: const, var, type, func, package. Default: true.


If something went wrong, the first thing you may want to do is manually start the gocode daemon with a debug mode enabled and in a separate terminal window. It will show you all the stack traces, panics if any and additional info about autocompletion requests. Shutdown the daemon if it was already started and run a new one explicitly with a debug mode enabled:

gocode close

gocode -s -debug

Please, report bugs, feature suggestions and other rants to the github issue tracker of this project.


There is Guide for IDE/editor plugin developers.

If you have troubles, please, contact me and I will try to do my best answering your questions. You can contact me via email. Or for short question find me on IRC: #go-nuts @ freenode.


  • It's a good idea to use the latest git version always. I'm trying to keep it in a working state.
  • Use go install (not go build) for building a local source tree. The objects in pkg/ are needed for Gocode to work.