Run/debug configurations
Configure: Run | Edit Configurations
Aqua uses run/debug configurations to run, debug, and test your code. Each configuration is a named set of startup properties that define what to execute and what parameters and environment should be used.
There are two types of run/debug configurations:
Temporary — created every time you run or debug your tests.
Permanent — created explicitly from a template or by saving a temporary configuration. Permanent configurations remain as part of your project until you remove them.
Whenever you run, debug, or test your code, Aqua either uses an existing permanent run/debug configuration or creates a new temporary one.
Permanent configurations have opaque icons while the icons of temporary configurations are semi-transparent. The red cross over the configuration icon indicates an error in configuration settings.
![Permanent and temporary confirugations have different icons Permanent and temporary confirugations have different icons](https://resources.jetbrains.com/help/img/idea/2024.3/aqua_rc_icons.png)
The maximum number of temporary configurations is 5. The older ones are automatically deleted when new ones are added. If necessary, you can increase this limit in Settings | Advanced Settings | Run/Debug | Temporary configurations limit.
![Temporary configurations limit Temporary configurations limit](https://resources.jetbrains.com/help/img/idea/2024.3/aqua_temp_config_limit.png)
Aqua provides the following ways to create a permanent run/debug configuration:
For test classes and methods, you can create a permanent run/debug configuration right from the editor.
Create from a template or copy an existing configuration.
Place the caret at the declaration of a test method or class and press AltEnter.
From the menu that opens, select Modify Run Configuration.
Aqua creates a permanent run/debug configuration of the corresponding type and opens a dialog in which you can set configuration parameters.
Set up the run/debug configuration parameters.
Select a temporary configuration in the run/debug configuration switcher, click
and select Save Configuration.
Aqua provides run/debug configuration templates for different languages, tools, and frameworks. The list of available templates varies depending on the installed and enabled plugins.
Go to Run | Edit Configurations. Alternatively, press AltShiftF10, then 00.
In the Run/Debug Configurations dialog, click
on the toolbar or press AltInsert. The list shows the run/debug configuration templates.
Select the desired template. If you are not sure which template to choose, refer to Run/debug configurations dialog for more information on particular templates.
Specify the run/debug configuration name in the Name field. This name will be used to identify the run/debug configuration in lists and menus.
Specify the configuration options.
You can either run the configuration right away or save the configuration to run it later.
To save the run configuration for later, click OK.
To run the configuration right away, click Run.
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 |
---|---|---|
AltInsert | Click this icon to add one of the following available tasks:
| |
AltDelete | 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. | |
Alt0↑ Alt0↓ | 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 Alt04 or Alt05. |
You might want to share your run/debug configurations so that your teammates could run the application using the same configuration or enable them to remotely attach to the process you are running.
Aqua provides a mechanism to store your run/debug configurations as project files and share them through VCS. The same mechanism can also be used when you want to send your configuration as a file to someone else, create a local backup of your run/debug configurations, or import them from a file.
Go to Run | Edit Configurations. Alternatively, press AltShiftF10, then 00.
Select the run/debug configuration you want to share, enable the Store as project file option, and specify the location where the configuration file will be stored.
(Optional) If the .idea directory is added to VCS ignored files, the .idea/runConfigurations subfolder will be ignored, too. If the project uses Git, you can share .idea/runConfigurations and leave .idea ignored by modifying .gitignore as follows:
/.idea/* !/.idea/runConfigurations
note
Turning on the Store as project file option does not submit anything to the VCS. For run/debug configurations to make their way to a shared repository, you have to check them in like the other versioned files.
All run/debug configurations are based on templates, which implement the startup logic, define the list of parameters and their default values. The list of available templates is predefined in the installation and can only be extended via plugins. However, you can edit default parameter values in each template to facilitate the setup of new run/debug configurations.
Go to Run | Edit Configurations. Alternatively, press AltShiftF10, then 00.
In the left-hand pane of the run/debug configuration dialog, click Edit configuration templates.
In the Run/Debug Configuration Templates dialog that opens, select a configuration type.
Specify the desired default parameters and click OK to save the template.
When there are many run/debug configurations of the same type, you can group them in folders for easier access.
![Grouped run configurations Grouped run configurations](https://resources.jetbrains.com/help/img/idea/2024.3/aqua_rc_folders.png)
Go to Run | Edit Configurations. Alternatively, press AltShiftF10, then 00.
In the Run/Debug Configurations dialog, select a configuration type and click
on the toolbar. A new empty folder for the selected type is created.
Specify the folder name in the text field to the right or accept the default name.
Select the desired run/debug configurations and move them under the target folder.
Apply the changes. If a folder is empty, it will not be saved.
When you no longer need a folder, you can delete it Delete. The run/debug configurations grouped under this folder will be moved under the root of the corresponding run/debug configuration type.
You can manage multiple run/debug configurations in the Services tool window. For example, you can start, pause, and stop several applications, track their status, and examine application-specific details.
Select View | Tool Windows | Services from the main menu or press Alt08.
In the Services tool window, click Add service, then select Run Configuration Type.
Select a run/debug configuration type from the list to add all configurations of this type to the window.
Note that the tool window will only display the configuration types for which you have created one or more configurations.
To run or debug multiple tasks simultaneously, open the run widget menu in the toolbar and select the corresponding run/debug configurations while holding down the Ctrl key.
For launching multiple tasks using a single run/debug configuration, refer to Run/debug multiple targets.
Thanks for your feedback!