Gocode is a helper tool which is intended to be integraded with your source code editor, like vim 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.
-
At this step, please make sure that your $GOBIN is available in your $PATH. By default $GOBIN points to $GOROOT/bin. This is important, because editors assume that gocode executable is available in one of the directories, specified by your $PATH environment variable. Usually you've done that already while installing the Go compiler suite.
Do these steps only if you know why do you need them:
export GOBIN=$HOME/bin
export PATH=$PATH:$HOME/bin
-
Then you need to get the appropriate version of the gocode, for 6g/8g/5g compiler you can do this:
go get -u github.com/nsf/gocode
(-u flag for "update") -
Next steps are editor specific. See below.
In order to install vim scripts, you need to fulfill the following steps:
-
Install official Go vim scripts from $GOROOT/misc/vim. If you did that already, proceed to the step 2.
-
Install gocode vim scripts. Usually it's enough to do the following:
cd vim && ./update.bash
update.bash script does the following:
#!/usr/bin/env bash mkdir -p ~/.vim/{autoload,ftplugin} cp autoload/gocomplete.vim ~/.vim/autoload cp ftplugin/go.vim ~/.vim/ftplugin
-
Make sure vim has filetype plugin enabled. Simply add that to your .vimrc:
filetype plugin on
-
Autocompletion should work now. Use
<C-x><C-o>
for autocompletion (omnifunc autocompletion).
In order to install emacs script, you need to fulfill the following steps:
-
Install auto-complete-mode
-
Copy emacs/go-autocomplete.el file from the gocode source distribution to a directory which is in your 'load-path' in emacs.
-
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.
You can change all available options using gocode set
command. The config file uses .ini-like format and usually stored somewhere in ~/.config/gocode directory.
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 an 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 ';').
If something went wrong, the first thing you may want to do is manually start the gocode daemon in a separate terminal window. It will show you all the stack traces and panics if any. Shutdown the daemon if it was already started and run a new one explicitly:
gocode close
gocode -s
Please, report bugs, feature suggestions and other rants to the github issue tracker of this project.
If you want to integrate gocode in your editor, please, contact me and I will tell you exactly what do you need. You can send me a message via github or simply contact me via email.
- It's a good idea to use the latest git version always. I'm trying to keep it in a working state.