gopls, the Go language server
You should not need to interact with
gopls directly--it will be automatically
integrated into your editor. The specific features and settings vary slightly
by editor, so we recommend that you proceed to the documentation for your
To get started with
gopls, install an LSP plugin in your editor of choice.
For the most part, you should not need to install or update
editor should handle that step for you.
If you do want to get the latest stable version of
gopls, change to any
directory that is both outside of your
GOPATH and outside of a module (a temp
directory is fine), and run:
GO111MODULE=on go get golang.org/x/tools/gopls@latest
NOTE: Do not use the
-u flag, as it will update your dependencies to
Learn more in the advanced installation instructions.
Setting up your workspace
gopls supports both Go module and GOPATH modes, but if you are working with
multiple modules or uncommon project layouts, you will need to specifically
configure your workspace. See the Workspace document for
information on supported workspace layouts.
You can configure
gopls to change your editor experience or view additional
debugging information. Configuration options will be made available by your
editor, so see your editor's instructions for specific details. A
full list of
gopls settings can be found in the Settings documentation.
gopls inherits your editor's environment, so be aware of any environment
variables you configure. Some editors, such as VS Code, allow users to
selectively override the values of some environment variables.
If you are having issues with
gopls, please follow the steps described in the
Supported Go versions and build systems
gopls follows the
Go Release Policy,
meaning that it officially supports the last 2 major Go releases. Though we
try not to break older versions, we do not prioritize issues only affecting
legacy Go releases.
gopls currently only supports the
go command, so if you are using a
different build system,
gopls will not work well. Bazel support is currently
Gopls (pronounced “go please”) is an LSP server for Go. The Language Server Protocol allows any text editor to be extended with IDE-like features; see https://langserver.org/ for details.
See https://github.com/golang/tools/blob/master/gopls/README.md for the most up-to-date documentation.
Command generate creates API (settings, etc) documentation in JSON and Markdown for machine and human consumption.
|Command generate creates API (settings, etc) documentation in JSON and Markdown for machine and human consumption.|
Package parse provides functions to parse LSP logs.
|Package parse provides functions to parse LSP logs.|
Package hooks adds all the standard gopls implementations.
|Package hooks adds all the standard gopls implementations.|
Package regtest provides a framework for writing gopls regression tests.
|Package regtest provides a framework for writing gopls regression tests.|