Run/debug configurations

Run kind

Building scope for your application. File and Package scopes work similarly in tests and compilation/running configurations (in terms of the scope they cover).

• Directory: build an application in the specified directory as a package, without processing any subdirectories.

  For test configurations, GoLand runs all the tests in the specified directory and all its subdirectories.

• File: build an application from files specified in the Files field. To pass multiple file paths, use the vertical bar (|) as a delimiter. This configuration is automatically selected when you run your program from scratch files.

• Package: build a single package with all its dependencies. Specify a full import path to the package that you want to build in the Package path field (for example, github.com/gorilla/mux). This configuration is automatically selected when you run the main function by using the Run Application icon () in the gutter.

Package path

Full import path of the package that you want to compile (for example, myServerApp). This field is available only when you select the Package run kind.

You can press Ctrl+Space to see a list of available packages.

Output directory

Path to a directory where you want to output the executable file.

Build on remote target

This checkbox appears when you select a non-local run target. It is cleared by default.

Select it to copy the source files to the target and build there. When you select it, GoLand hides the Output directory field.

Clear it to build locally and copy the executable to the target.

If the selected Go SDK is located in WSL, GoLand builds on the run target even when this checkbox is cleared. For more information, refer to Run on a target.

Run after build

Execute the application after the build.

Emulate terminal in output console

Executes the application and displays the output in the Run tool window as it would appear in the terminal.

Redirect input from

File to read the input from.

Working directory

Directory that is used for the built application. If you have any code that creates relative files or directories, they will be relative to this directory.

Environment

Environment variables for your application.

To edit environment variables, click the Browse button at the end of the field. In the Environment Variables dialog, click the Add button and add the environment variables that you need.

Go tool arguments

Arguments for the go tool (for example, -o). Also, you can use macros in this field.

Use all custom build tags

Select this checkbox to add the tags from the Custom tags field under Go | Build Tags to the build command.

If Go tool arguments already contains -tags, the command uses those tags instead.

Program arguments

Arguments for the built application. Also, you can use macros in this field.

Run with sudo

Run the application with elevated privileges.

Module

Name of the current module.

Before launch

Add tasks that you want to launch before the launch of the selected run/debug configuration. To add a task click the Add button Alt+Insert and select the tool that you want to add.

Store as project file

Enable this option to save your configuration as a project file and share it with team members through VCS.

Test framework

Select the test framework to use.

• gotest: run standard Go tests. For more information about go test, refer to Package testing.

• gocheck: run tests with the gocheck framework.

• gobench: run benchmarks. For more information, refer to Package testing: Benchmarks.

• go test -fuzz: run fuzz tests. Fuzzing sends random or unexpected input to your code to find problems. For more information, refer to Go Fuzzing.

  Use Run to start fuzzing. The Debug action is unavailable for the go test -fuzz framework.

Test kind

Select the scope from which you want to run tests:

• Directory: run tests in the selected directory and its subdirectories. Specify the directory in the Directory field.

  To debug tests, select Package instead.

• Package: run tests in a package. In the Package path field, enter the package import path, for example, example.com/myapp/calc.

• File: run tests from the selected files. In the Files field, enter file paths separated by |, for example, /work/myapp/calc.go|/work/myapp/calc_test.go. Select files from the same directory. At least one file needs to support the selected test framework.

Pattern

This field is available for Directory and Package scopes. For File scope, GoLand generates the pattern from the test functions in the selected files when no pattern is set.

Enter a regular expression to select the tests to run. For tests with subtests, separate the expressions with /. The first expression matches the test name, and each following expression matches a subtest name at the next level.

For example, to run the add_positive_and_negative subtest of TestAdd, enter ^\QTestAdd\E$/^\Qadd_positive_and_negative\E$.

Working directory

Directory that is used for the built application. If you have any code that creates relative files or directories, they will be relative to this directory.

Output directory

Directory for the compiled test executable when you use File or Package scope.

Build on remote target

This checkbox appears when you select a non-local run target. It is cleared by default.

Select it to copy the source files to the target and build there. When you select it, GoLand hides the Output directory field.

Clear it to build locally and copy the executable to the target.

If the selected Go SDK is located in WSL, GoLand builds on the run target even when this checkbox is cleared. For more information, refer to Run on a target.

Redirect input from

Path to the file to use as standard input instead of the console.

Environment

: environment variables that you need to run the test.

To edit environment variables, click the Browse button at the end of the field. In the Environment Variables dialog, click the Add button and add the environment variables that you need.

Go tool arguments

Arguments for the go tool (for example, -tags).

Use all custom build tags

Select this checkbox to add the tags from the Custom tags field under Go | Build Tags to the build command.

If Go tool arguments already contains -tags, the command uses those tags instead.

If neither Go tool arguments nor this checkbox supplies -tags, GoLand can select tags from //go:build and // +build constraints in the test files. This applies to File scope and to Package scope when GoLand can identify the selected test functions.

Program arguments

Arguments for the test.

Run with sudo

Run the tests with elevated privileges. This option is available for local configurations when the operating system supports process elevation.

Before launch: Activate tool window

Add tasks that you want to launch before the launch of the selected run/debug configuration. To add a task, click the Add button Alt+Insert and select the tool that you want to add.