Gradle tasks

Run a Gradle task in the Run Anything window

1. In the Gradle tool window, on the toolbar, click . Alternatively, press Ctrl twice to open the Run Anything window.

2. In the Run Anything window, start typing a name of the task you want to execute. To execute several tasks, enter task names using space to separate each new task. Alternatively, scroll down to the Gradle tasks section and select the task you need. Press Enter.

   

   If you have linked projects and want to run a task for the specified project then in the Run Anything window, in the top-right corner, from the Project list, select the name of the project and in the search field enter the name of your task.

   note

   If you have options such as offline mode configured for the project, IntelliJ IDEA will automatically include the configuration into the running scope.

3. IntelliJ IDEA runs the specified task and displays the result in the Run tool window.

   

   IntelliJ IDEA also saves the task in the Run Anything window under the Recent section as well as under the Run Configurations node in the Gradle tool window.

   

Run a Gradle task via Run Configurations

You can add some additional parameters to your task, configure it as a run configuration, save it and use that run configuration in your project whenever you need.

1. Open the Gradle tool window.

2. Right-click the task for which you want to create the Run configuration.

3. From the context menu select Modify Run Configuration.

   

4. In Create Run Configuration: 'task name', you can use the default settings or configure the additional options and click OK.

   

   IntelliJ IDEA displays the task under the Run Configurations node.

   

5. Double-click the task to run it or right-click the task and from the context menu select Run.

   

Run a Gradle task from the context menu

1. Open the Gradle tool window.

2. Right-click a task that you want to run.

3. From the context menu select Run 'task name'.

   

Run several Gradle tasks simultaneously

You can create a run configuration for several tasks.

1. Select Run | Edit Configurations Alt+Shift+F10.

   The Run/Debug Configurations dialog opens.

2. In the Run/Debug Configurations dialog, click and select Gradle to add a new configuration.

   

3. On the right side of the Run/Debug Configurations dialog, in the Name field, enter the name of your configuration. Also, you can specify where you want to run your configuration. Use the Run on drop-down list to specify the run target option.

   Use the Run section to specify settings for the run configuration.

   As an example, check the following settings:

   • Tasks and Arguments - specify tasks and arguments you want to execute with this configuration. You can run more than one task. Click inside the field to open the Tasks and Arguments dialog to select the needed options.

     For example, specify clean and build, and add the argument --debug.

   • Gradle project - click and select the registered Gradle project.

   • If you want to add VM options, click the Modify options link and in the dialog that opens, under Java section, select Add VM options. The VM options field is added to the run configuration and you can specify the needed parameters. For example, specify -Xmx3g.

   

   For more information on run configurations, refer to Run/debug configurations.

4. Click OK.

   The created configuration is added to the Run Configurations node in the Gradle Projects tool window.

5. Double-click the configuration to run the task or right-click the configuration and select Run.

   

Configure Gradle debugging process

1. Create a run/debug configuration. If you have the existing run/debug configuration, select it on the main menu, and click Edit Configurations.

2. On the Run/Debug Configurations page, click the Gradle Debug tab.

3. Use the following options to configure the gradle debugging process:

   • Enable Gradle script debugging: by default, this option is disabled, select it to enable breakpoints in the Gradle build script.

     If the Choose per test option is selected in the Gradle settings, IntelliJ IDEA clears the Enable Gradle script debugging option and disables the breakpoints in the Gradle scripts. This is done to speed up your debugging process.

   • Debug forked tasks in the same session: when this option is selected any new debugging process is run under the same tab in the Debug tool window. Clear this option if you want to see each debugging process in a separate tab.

     

   • Debug all tasks on the execution graph: when you select this option, every task in the execution graph will be debugged. For example, all the dependent tasks of the task you are trying to debug will be debugged as well.

Debug a Gradle script task

1. Open your build.gradle in the editor.

2. Set your breakpoints and in the gutter right-click the Run icon. From the context menu, select Debug <name>.

   

   note

   If you started the debugging session for the regular tests first, then open the existing run/debug configuration, select Enable Gradle script debugging option, save the changes and restart the debugging process.

3. IntelliJ IDEA starts the debugging session and you can check the results in the Debug tool window.

   

Debug a Gradle task

Use the Gradle tool window to debug Gradle tasks that implement the org.gradle.process.JavaForkOptions interface, for example, test or run.

1. In the Gradle tool window, click the project, open the Tasks node, and right-click a task you want to debug.

2. From the context menu, select Debug.

   The debugging process is started and the task is added to the list of the recent tasks located under the Run Configurations node.

1. In the Gradle tool window, right-click the desired task.

2. From the context menu, choose Assign Shortcut.

   

   The Keymap dialog opens.

3. In the Keymap dialog, under the Gradle node navigate to your task.

4. Right-click the task and from the list that opens, select a type of the shortcut you want to assign.

   

5. In the dialog that opens, depending on the shortcut's type, configure your shortcut and click OK.

   In our case let's add a keyboard shortcut.

   

   You can see that the shortcut is displayed against your task in the Gradle tool window.

   

1. In the Keymap dialog, under the Gradle node, click Choose a task to assign a shortcut.

   

2. In the dialog that opens, select a task you need and click OK.

   

   The task is added to the list under the Gradle node. Now you can configure the shortcut.

tip

You can create a quick list of favorite Gradle tasks and refer to that list by the associated shortcut.

1. In the Gradle tool window, right-click a Gradle project.

2. From the context menu, select Tasks Activation.

3. In the Tasks Activation dialog, click .

4. On the Choose activation phase menu, choose when to run your task, for example, Before Build, After Sync, and so on.

5. On the Choose task menu, select the actual task.

   The task and activation phase will be added to the list in the Task Activation dialog. You can also see the activation phase name against the selected task in the Gradle tool window.

1. From the main menu, select Run | Edit Configurations to open the run/debug configuration for your project.

2. In the Run/Debug Configurations dialog, in the Before Launch section, click the icon.

3. In the list that opens, select Run Gradle task.

4. In the Select Gradle Task dialog, specify the project and the task that you want to execute before launching the project. You can specify a Gradle linked project or any other Gradle project. Note that if your Gradle project is not linked then IntelliJ IDEA will use the default configurations (for example, a bundled Gradle version) to run the task.

5. Click OK.