Installing and launching GoLand

1. Download Toolbox App.

2. Launch the setup file.

3. When the installation is complete, accept the JetBrains privacy policy and sign in to your JetBrains Account.

Set up a workspace

Before you start creating or importing your GoLand project, make sure you have done the following:

1. Created a workspace where you keep projects.

   Use the following layout:

   • work

     • bin

     • pkg

     • src
       • github.com
         • user_name

           • project1

           • project2

2. Downloaded Go distribution.

3. Defined the environment variable GOPATH that points to the workspace location. This variable will be used by Go commands and the IDE to resolve import statements, install, build and update packages, etc.

Create a new project

1. Click Create New Project on the Welcome screen.

2. If the workspace is set up then GoLand will suggest you to create a project in the src subdirectory. Specify the name of your project in the Location field, the Go SDK (GOROOT) and click Create. GoLand creates a project in the workspace and the appropriate Go settings.

   

Open an existing project

1. On the Welcome screen click Open and select the project directory. If your project is not inside the created workspace, move the project into your workspace first.

2. When you open your project GoLand automatically tries to locate SDK (GOROOT). If GoLand cannot find GOROOT, the appropriate message with a link will appear suggesting to configure the Go SDK.
   Click the suggested link and specify the location of the Go distribution. After you set SDK, wait until GoLand finishes indexing the workspace.

Attach a directory to an already-opened project

You can attach a directory to an already-opened project. For example, when you need to open several projects in a single GoLand instance as you want.

1. Navigate to File | Open.

2. Navigate to the folder with the project that you want to attach.

3. Click Open.

4. In the Open Project dialog, click Attach.

Detach the attached directory

In settings (Ctrl+Alt+S), navigate to Go | Project structure. In the pane with the project structure, click the Remove Content Entry icon ().

Run applications

You can quickly create and run a Go application.

1. In the Project tool window, right-click the project.

2. From the context menu, select New | Go File.

3. In the dialog that opens, specify the name of your application and select Simple Application from the Kind drop-down list.
   GoLand creates an executable application.

4. In the editor add code and click the icon in the left gutter or press Ctrl+Shift+F10 to run the application. The result is displayed in the Run tool window.

Run a program

To run a Go code, you need to adjust your run configuration or create a new one. You can manage your run configurations in the Run/Debug Configurations dialog.

1. On the main menu, select Run | Edit Configurations.

2. In the Run/Debug Configurations dialog, click and from the list that opens, select the appropriate configuration.

   • The Go Build type is equal to go build command.

   • The Go Test type is equal to go test. Make sure to select the test framework your tests use: gotest, gocheck or gobench.

   • The Go App Engine type lets you run Go App Engine applications. Note, it requires your Go module to use a Go AppEngine SDK.

3. Specify the run configuration options. You can also specify Before Launch options, for example, you can add a Go command that you want to run before executing the created configuration. Click OK.

4. On the main menu, select Run | Run < configuration_name> or press Ctrl+Shift+F10.

Change the GOPATH or the GOROOT settings

1. Press Ctrl+Alt+S to open the Settings/Preferences dialog.

2. From the options on the left, click GO and depending on the settings you want to change, select either GOPATH or GOROOT.

3. On the GOROOT settings page, you can change the GOROOT location or specify a new version of the downloaded Go SDK.
   On the GOPATH settings page, you can change GOPATH global and project-level settings. If you'd like to use a GOPATH different from the one specified in the environment variable, clear the option Use GOPATH that's defined in system environment and specify the one you want.