GOROOT and GOPATH

Go tools expect a certain layout of the source code. GOROOT and GOPATH are environment variables that define this layout.

GOROOT is a variable that defines where your Go SDK is located. You do not need to change this variable, unless you plan to use different Go versions.

In Go development, the GOPATH variable, which defaults to $HOME/go on Unix and %USERPROFILE%\go on Windows, serves several purposes:

Binaries are installed to $GOBIN by go install, with $GOBIN defaulting to $GOPATH/bin.
Modules are cached in $GOMODCACHE by go get, defaulting to $GOPATH/pkg/mod.
Checksum database state is cached in $GOPATH/pkg/sumdb by go get.

For details about the GOPATH variable, refer to the go command documentation.

The concept of GOPATH development mode, which precedes Go modules, is now deprecated. Prior to Go modules, the GOPATH was used to install binaries and compiled packages, as well as downloading source code to specified paths. For more information about developing with GOPATH, refer to GOPATH development mode at go.dev.

Consider the following video where we change the Go SDK from 1.16 Beta 1 to 1.20.1.

GOROOT

Configure GOROOT

To see the current value of GOROOT, open settings (Ctrl+Alt+S) and navigate to Go | GOROOT. Click the drop-down list and select the Go version.
If no Go version is available, click the Add SDK button to download a Go version or select a path to a local copy of Go SDK.

Select a local copy of the Go SDK

Ensure that the provided path to the folder with Go SDK includes bin and src folders.

Open settings (Ctrl+Alt+S) and navigate to Go | GOROOT.
Click the Add SDK button and select Local.
In the file browser, navigate to the SDK version that is on your hard drive.
Click Open.

Download the Go SDK

Open settings (Ctrl+Alt+S) and navigate to Go | GOROOT.
Click the Add SDK button () and select Download.
From the Version list, select the SDK version.
In the Location field, specify the path for the SDK. To use a file browser, click the Browse icon .
Click OK to close the Download Go SDK dialog.
As you click Apply or OK on the GOROOT page, GoLand will start downloading and unpacking the Go SDK.

Using asdf

asdf is a tool that manages multiple versions of different programming languages and utilities. It allows switching between different Go versions for different projects. Also, asdf can set different scopes: asdf global, which sets a default version for the entire system, and asdf local, which sets a version for a specific directory.

GoLand supports asdf local and asdf global commands, including specifying multiple versions (for example, asdf local golang 1.21.0 1.20.8).

Select an asdf Go version for the project

Open settings by pressing Ctrl+Alt+S and navigate to Go | GOROOT. .
From the list, select the Go version that you need.

GOPATH

Configuring GOPATH for different scopes

You can configure GOPATH for the following scopes:

Global GOPATH: settings apply to all projects of a specific installation of GoLand.
Project GOPATH: settings apply only to the current project.
Module GOPATH: settings apply only to one module. A module can have an SDK that is different from those configured for a project. They can also carry a specific technology or a framework.

If you specified all three scopes, GoLand selects the narrowest scope first.

Open settings (Ctrl+Alt+S) and navigate to Go | GOPATH.
Depending on the scope that you want to apply, select the corresponding section (Global GOPATH, Project GOPATH, or Module GOPATH) and click the Add button .
In the file browser, navigate to the directory that you want to associate with GOPATH.
In the following example, we configured to use different GOPATH directories for different scopes. GoLand will use the Module GOPATH as it is the narrowest scope configured.

Last modified: 11 October 2024