Go Build

Create: Run | Edit Configurations | | Go Build

With the Go Build configuration, you can run, compile, and debug Go applications. For more information about creating a run/debug configuration from a template, refer to Create a run/debug configuration from a template.

Item	Description
Run kind	Select a 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. The Package run type is a default. 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 or a separate test by using the Run Application icon () in the gutter.
Package path	Type or autocomplete a full import path of the package that you want to compile (for example, `github.com/gorilla/mux`). This field is available only when you select the Package run kind. You can press `Ctrl+Space` to see a list of available packages.
Directory	Type a path to the directory of your Go application that you want to compile (for example, `/Users/jetbrains/go/src/serverApp`). This field is available only when you select the Directory run kind.
Files	Type a path to a file or files of your Go application that you want to compile (for example, `/Users/jetbrains/go/src/serverApp/main.go`). To pass multiple file paths, use the vertical bar (`\|`) as a delimiter. This field is available only when you select the File run kind.
Output directory	Type a path to a directory where you want to output the executable file.
Run after build	Execute the application after the build.
Redirect input from	Specify a file to read the input from.
Working directory	Type a 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	Specify 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	Type arguments for the go tool (for example, `-o`). Also, you can use macros in this field.
Use all custom build tags	Specify all tags that are applied during the build. Tags are listed in settings `Ctrl+Alt+S` under Go \| \| Build Tags.
Program arguments	Type 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.

Common settings

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item	Description
Name	Specify a name for the run configuration to quickly identify it among others when editing or running.
Allow multiple instances	Allow running multiple instances of this run configuration in parallel. By default, it is disabled, and when you start this configuration while another instance is still running, GoLand suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.
Store as project file	Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project. By default, it is disabled, and GoLand stores run configuration settings in .idea/workspace.xml.

Item

Description

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

Allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, GoLand suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and GoLand stores run configuration settings in .idea/workspace.xml.

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

Item	Shortcut	Description
	`Alt+Insert`	Create a run/debug configuration.
	`Alt+Delete`	Delete the selected run/debug configuration. Note that you cannot delete default configurations.
	`Ctrl+D`	Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
		The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
		Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders. To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created. Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons. To remove grouping, select a folder and click .
		Click this button to sort configurations in the alphabetical order.

Before launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

Item	Shortcut	Description
	`Alt+Insert`	Click this icon to add one of the following available tasks: Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in GoLand yet, add its definition. Run Another Configuration: select to execute another run/debug configuration and wait until it finishes before starting the current configuration. If you want to run several configurations in parallel, use a compound run/debug configuration. Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser to be launched with the JavaScript debugger. Run File Watchers: select this option to have GoLand apply all the currently active File Watchers. Run Grunt task: select this option to run a Grunt task. In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package. Run gulp task: select this option to run a Gulp task. In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package. Run npm script: select this option to execute an npm script. In the NPM Script dialog that opens, specify the npm run/debug configuration settings. Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected: If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start. If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched. Run Go Command: select to run a Go command before running your program. For example, you can run `go generate` to generate source code before compilation. In the Edit Go Command Task dialog, you can use auto-completion. Auto-completion supports the following commands `generate`, `vet`, `test -i`. You can use your own commands. Run Remote External Tool: adds a remote SSH external tool. Disconnect Data Source: select this option if you want to disrupt the connection to a data source before the run/debug configuration is run.
	`Alt+Delete`	Click this icon to remove the selected task from the list.
	`Enter`	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
	`Alt+Up` `Alt+Down`	Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.
Show this page		Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window		By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing `Alt+4` or `Alt+5`.

Last modified: 11 October 2024

Go Build

Common settings

Toolbar

Before launch