Work with Gradle tasks
IntelliJ IDEA lets you create, debug and manage Gradle tasks in your project.
Run Gradle tasks
IntelliJ IDEA lets you run Gradle tasks using several different ways such as using a toolbar in the Gradle tool window, using a run configuration, using a context menu, and even run several tasks using one run configuration.
Moreover, when you work in the distraction-free mode (without toolbars and tool windows), you can run Gradle tasks or commands from the Run Anything window. Press Ctrl twice to open it, type your command and press Enter.
You can check the Mastering shortcuts section for more information.
Run a Gradle task from the Gradle toolbar
In the Gradle projects tool window, on the toolbar, click .
In the Run Gradle Task dialog, in the Command line field, start entering the name of your task. You can see that IntelliJ IDEA displays the list of Gradle tasks from which you can select the appropriate one. Click OK.
IntelliJ IDEA runs the selected task and displays the result in the Run tool window. IntelliJ IDEA also saves the task in Gradle projects under the Run Configurations node.
Run a Gradle task via Run Configurations
Open the Gradle projects tool window.
Right-click the task for which you want to create the Run configuration.
From the context menu select Create 'task name'.
In Create Run/Debug Configuration: 'task name', specify the task settings and click OK. IntelliJ IDEA displays the task under the Run Configurations node.
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
Open the Gradle projects tool window.
Right-click a task that you want to run.
From the context menu select Run 'task name'.
Run several Gradle tasks with one Run/Debug configuration
The Run/Debug Configurations dialog opens.
In the Run/Debug Configurations dialog, click and select Gradle to add a new configuration.
- On the right side of the Run/Debug Configurations dialog, in the Name field, enter the name of your configuration.
As an example, specify the following settings:
Gradle project - click and select the registered Gradle project.
Tasks - specify tasks you want to execute with this configuration. You can run more than one task.
For example, specify
VM options - you can customize VM options. For example, specify
Arguments - you can specify Gradle command line parameters. For example, specify
The created configuration is added to the Run Configurations node in the Gradle Projects tool window and is treated as a Gradle task.
Double-click the configuration to run the task or right-click the configuration and select Run.
Debug Gradle tasks and scripts
You can debug Gradle tasks and scripts the same way you debug your regular applications.
You can start the debug session from the editor or from the Gradle projects tool window.
Debug a Gradle script task
Open your build.gradle in the editor.
Set your breakpoints and in the left gutter right-click the Run ( ) icon. From the context menu, select Debug <name>.
IntelliJ IDEA starts the debugging session and you can check the results in the Debug tool window.
Debug a Gradle task
- In the Gradle projects tool window, in the Tasks area, double-click a Gradle project.
The list of tasks opens.
- In the list of tasks, select the task which you want to debug, right-click it and 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.
Assign a shortcut to a Gradle task
IntelliJ IDEA lets you assign shortcuts to Gradle tasks that can be run in several ways and execute those tasks with a single key-stroke. You can also assign a shortcut to the Gradle run/debug configuration that can contain more than one task.
In the Gradle projects tool window, right-click the desired task.
From the context menu, choose Keymap dialog opens.. The
In the Keymap dialog, under the Gradle node navigate to your task.
Right-click the task and from the list that opens, select a type of the shortcut you want to assign.
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 projects tool window.
While in the Keymap dialog, you can add a new task to which you want to assign a shortcut.
In the Keymap dialog, under the Gradle node, click Choose a task to assign a shortcut.
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.
Configure running triggers for Gradle tasks
IntelliJ IDEA lets you run Gradle tasks before your project's execution or set other conditions using the task activation configuration.
In the Gradle projects tool window, right-click a Gradle project.
From the context menu, select Task Activation.
In the Task Activation dialog, click .
On the Choose activation phase menu, choose when to run your task, for example, Before Build, After Sync,and so on.
- 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 projects tool window.
Alternatively, you can select the activation phase name from the context menu when you right-click the task you want to execute in the Gradle projects tool window.
You can also create a run/debug configuration that would depend on a Gradle task.
On the main menu, selectto open the run/debug configuration for your project.
In the Run/Debug Configurations dialog, in the Before Launch section, click the icon.
In the list that opens, select Run Gradle task.
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.