GoLand 2020.3 Help

Run/Debug Configuration: Shell Script

Use this dialog to configure running separate shell scripts. For details on working with shell scripts in GoLand, see Shell scripts.

The dialog consists of the following areas:

ItemDescription
Script pathIn this field, provide the path to the shell script file. Type the path manually or click the Browse button and select the path in the dialog that opens.
Script optionsIn this field, specify the options that you want to pass to the script when it is launched.
Interpreter pathIn this field, provide the path to the interpreter for running the script. Type the path manually or click the Browse button and select the path in the dialog that opens.
Interpreter options In this field, specify the options that you want to pass to the script interpreter.

Common

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/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to 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 to stop the running instance and start another one. This is helpful when a run/debug 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.

Output directoryDirectory that stores your results (for example, an executable file).
Working directoryDirectory 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.
EnvironmentEnvironment variables that you need to run the application.
Go tool argumentsArguments for the go tool (for example, -tags).
Use all custom build tagsAll tags that are applied during the build. Tags are listed in settings Ctrl+Alt+S under Go | Build Tags & Vendoring.
Program argumentsArguments for the application that was built.
ModulesName of the opened project in the Project tool window.
Run with sudoGrant sudo privileges for the application.
Before launch: Activate tool windowAdd tasks that you want to launch before the launch of your application. To add a task, click the Add button Alt+Insert and select the tool that you want to add.

Toolbar

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.

ItemShortcutDescription
the Add buttonAlt+InsertCreate a run/debug configuration.
the Remove buttonAlt+Delete Delete the selected run/debug configuration. Note that you cannot delete default configurations.
CopyCtrl+D Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
Edit Templates View and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and used for newly created configurations.
Method up/Method downAlt+Up/Alt+Down

Move the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

Move into new folder / Create new folder

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 Folder, 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 Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations Click this button to sort configurations in the alphabetical order.

Before Launch

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

ItemShortcutDescription
the Add buttonAlt+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. In the dialog that opens, select the configuration to be run.

  • 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 be launched with 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.

  • 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.

the Remove buttonAlt+Delete Click this icon to remove the selected task from the list.
EditEnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/Method downAlt+Up/Alt+DownClick 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 pageSelect 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: 19 August 2020