IntelliJ IDEA 2017.2 Help

Run/Debug Configuration: Spring Boot

This feature is supported in the Ultimate edition only.

Use this dialog box to create configurations used to run or debug Spring Boot applications.

This dialog box consists of the following areas:

Configuration tab

Use this tab to configure general run/debug configuration settings, and the specific Spring Boot settings.

ItemDescription
Main class In this text box, specify the fully qualified name of the class to be executed (passed to the JRE). Enter the class name manually or click the Browse button browseButton and search for the desired class by name or through the project.
VM options If necessary, specify the command-line options to be passed to the server JVM at the server start.

When specifying the options, follow these rules:

  • Use spaces to separate individual options, for example, -client -ea -Xmx1024m.
  • If an option includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".
  • If an option includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".
Program arguments Enter a list of arguments to be passed to the program in the format you would use in the command line. If there is not enough space, click the shift enter button button and enter the parameters in the Program Parameters dialog box.

Use the same rules as for specifying the VM options.

Working directory If necessary, specify a directory to be used by the running text. This directory is the starting point for all relative input and output paths. By default, this is the project directory. To specify a different directory, click the Browse button browseButton and select a directory in the dialog that opens.
Environment variables Click the Browse button browseButton to open the Environment Variables dialog where you can create variables and specify their values.
Use classpath of module Select the module whose classpath will be used to run the application.
JRE By default, the newest JDK from the module dependencies is used to run the application. If you want to specify an alternative JDK or JRE here, select it from the drop-down list.
Enable debug output Select this option to enable logging of the debug output.
Hide Banner Select this option to hide the startup banner printed by Spring Boot when starting a run/debug session.
Active Profiles If necessary, specify active Spring profiles that you want to use in this run/debug configuration.
Override parameters Use this table to specify which Spring Boot configuration parameters you want to override. Such parameters are normally defined in configuration files. Listing them in a run/debug configuration allows you to easily switch parameters by modifying the run/debug configuration instead of config files, or have multiple run/debug configurations with different parameter values. When you add a new parameter and start typing its name, IntelliJ IDEA provides content completion and displays a list of parameters that match the string you've entered. Use the following controls:
  • checkbox: use the checkboxes in the Enabled column to select which parameters you want to override. You can simply deselect the parameters you do not need to override at the moment without removing them and losing their values.
  • add: click this icon to add a parameter you want to override to the list.
  • delete: click this icon to remove a parameter from the list.
  • arrowUp/arrowDown: click these icons to move the selected parameter up or down in the list.

Logs tab

Use this tab to specify which log files generated while running or debugging must be displayed in the console, that is in the dedicated tabs of the Run tool window and the Debug tool window.

ItemDescription
Is active Select checkboxes in this column to have the corresponding log entries displayed in the Run tool window and the Debug tool window.
Log File Entry The read-only fields in this column list the log files to be shown. This list can contain:
  • Full paths to specific files
  • Ant patterns that define the range of files to be displayed
  • Aliases that substitute full paths or patterns. These aliases are also displayed in the tab headers where the corresponding log files are shown.

    Note that if a log entry pattern defines more than one file, the tab header shows the name of the file instead of the lof entry alias.

Skip Content Select the checkboxes in this column to skip the previous contents of the selected log.
Save console output to file Select this option to save the console output to a specified location. Type the path manually, or click the Browse button browseButton and select a location in the dialog that opens.
Show console when standard out changes Select this option to activate the output console and bring it forward if the associated process is writing to Standard.out.
Show console when standard error changes Select this option to active the output console and bring it forward if the associated process is writing to Standard.err.
new Click this button to add a new log file entry. Specify the associated properties in the Edit Log Files Aliases dialog.
edit1 Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
delete Click this button to remove the selected log entry from the list.
browseButton Click this button to edit the selected log file entry. This button only appears when an entry is selected.

Before launch options

Use this section to specify which tasks must be carried out before starting the run/debug session. The tasks you specify will be performed in the order that they appear in the list.

ItemShortcutDescription
new Alt+Insert Click this icon to add a task to the list. Select from the following task types:
  • Run External tool: select this option to run an application that is external to IntelliJ IDEA. Select the application(s) you want to run in the dialog that opens. If the required application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Make: select this option to compile the project or module. If a particular module is specified in the run/debug configuration, the Make Module command will be executed. Otherwise, the Make Project command will be performed.
  • Make, no error check: the same as the Make option, but IntelliJ IDEA will try to launch the run/debug session irrespective of the compilation result.
  • Build Artifacts: select this option to build one or several artifacts. Select the artifacts you want to build in the dialog that opens. For more information, see Working with Artifacts.
  • Run Another Configuration: select this option to have a different run/debug configuration executed first. Select the configuration that you want to run in the dialog that opens.

    This option is available only if you have already at least one run/debug configuration in the current project.

  • Make Project: select this option to compile all files that have been modified since the last compilation, and dependent source files.
  • Run Ant target: select this option to run an Ant target. Select the target you want to run in the dialog that opens. For more information, see Ant.
  • Run Gradle task: select this option to run a Gradle task. In the dialog that opens, specify the Gradle project, the tasks you want to run, and, if necessary the VM options and script parameters. For more information, see Gradle.
  • Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. Specify where your CoffeeScript source files are located in the dialog that opens. For more information, see CoffeeScript Support.
  • Run Maven Goal: select this option to run a Maven goal. Select the goal you want to run in the dialog that opens. For more information, see Maven.
  • Run Remote External tool: select this option to run a remote application external to IntelliJ IDEA. Select the remote application(s) you want to run in the dialog that opens. If the required application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
delete Alt+Delete Click this icon to remove the selected task from the list.
edit1 Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp/arrowDown Alt+Up / Alt+Down Click these icons to move the selected task one line up or down in the list.
Show this page N/A Select this check box to show the run/debug settings before starting a run/debug session.
Last modified: 29 November 2017

See Also