JetBrains Fleet 1.30 Help

Java run configurations

This topic summarizes the run configurations available for Java. Each table provides keys that are available within a run configuration and their descriptions.

jps-build

Build JVM modules described in IntelliJ project model

environment

Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example:

"environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }

dependsOn

Names of other configurations which will be executed before this configuration, for example: "dependsOn": ["first", "second"]. For more information, refer to Chained run configurations.

workingDir

Working directory for this run configuration.

allowParallelRun

When set to true, more than one instance of this configuration can run in parallel.

includeTests

Indicates whether to compile test source code

Default value: true

incremental

Indicates whether incremental compilation caches can be used

Default value: true

module

Specifies the name of the module to be built (together with its dependencies)

Default value: null

files

Specifies files to be compiled

Default value: []

parallel

Indicates whether independent modules can be compiled in parallel

Default value: true

additionalVmOptions

Additional JVM options for the JPS process in the form of a JSON array, for example, "additionalVmOptions": [ "-Xmx1024m", "-Djava.awt.headless=true"]

Default value: []

Example:

{ "name": "Build", "type": "jps-build", "module": "spring-petclinic", "includeTests": false }

jps-run

Run JVM applications described in IntelliJ project model

mainClass

(required)

Class with the main method to run

module

(required)

Name of the JPS module whose compilation output with dependencies will be added to the runtime classpath

environment

Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example:

"environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }

dependsOn

Names of other configurations which will be executed before this configuration, for example: "dependsOn": ["first", "second"]. For more information, refer to Chained run configurations.

workingDir

Working directory for this run configuration.

allowParallelRun

When set to true, more than one instance of this configuration can run in parallel.

args

Command-line arguments for the Java program. The value is a JSON array, for example, "args": ["I", "love", "Fleet"].

Default value: []

includeTests

Indicates whether test sources compilation output should be included in the runtime classpath

Default value: false

options

JVM options in the form of a JSON array, for example, "options": [ "-Ddebug", "-ea"]

Default value: []

pty

Show process output in PTY true or in read-only view false

Default value: true

Example:

{ "name": "Run Java App", "type": "jps-run", "workingDir": "$PROJECT_DIR$", "dependsOn": [ "Build" ], "mainClass": "org.springframework.samples.petclinic.JavaApp", "module": "spring-petclinic", "options": [ "-Dfile.encoding=UTF-8" ] }

jps-test

Runs JVM tests described in IntelliJ project model.

module

(required)

Name of the JPS module whose compilation output with test dependencies will be added to the runtime classpath

environment

Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example:

"environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }

dependsOn

Names of other configurations which will be executed before this configuration, for example: "dependsOn": ["first", "second"]. For more information, refer to Chained run configurations.

workingDir

Working directory for this run configuration.

allowParallelRun

When set to true, more than one instance of this configuration can run in parallel.

options

JVM options, including test runner main class with arguments. The value is a JSON array, for example, "options": [ "-Ddebug", "-ea"].

Default value: []

pty

Show process output in PTY true or in read-only view false

Default value: true

Example:

{ "name": "VetTests", "type": "jps-test", "workingDir": "$PROJECT_DIR$", "dependsOn": [ "Build" ], "module": "spring-petclinic", "options": [ "-ea", "-Didea.test.cyclic.buffer.size=1048576", "-Dfile.encoding=UTF-8", "-classpath", "$USER_HOME$/.m2/repository/org/junit/platform/junit-platform-launcher/1.7.2/junit-platform-launcher-1.7.2.jar:$USER_HOME$/Library/Caches/JetBrains/Fleet/intellij-plugin/fleet-backend-233.11416.tar.zst_748564d0a2c518e07a5ac0548b2099cb/FleetBackend 2023.3 EAP.app/Contents/lib/idea_rt.jar:$USER_HOME$/Library/Caches/JetBrains/Fleet/intellij-plugin/fleet-backend-233.11416.tar.zst_748564d0a2c518e07a5ac0548b2099cb/FleetBackend 2023.3 EAP.app/Contents/plugins/junit/lib/junit5-rt.jar:$USER_HOME$/Library/Caches/JetBrains/Fleet/intellij-plugin/fleet-backend-233.11416.tar.zst_748564d0a2c518e07a5ac0548b2099cb/FleetBackend 2023.3 EAP.app/Contents/plugins/junit/lib/junit-rt.jar", "com.intellij.rt.junit.JUnitStarter", "-ideVersion5", "-junit5", "org.springframework.samples.petclinic.vet.VetTests" ] }

maven

Run Maven commands

tasks

(required)

Maven goals and phases to run. The value is a JSON array, for example, "tasks": ["clean", "failsafe:integration-test"].

environment

Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example:

"environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }

dependsOn

Names of other configurations which will be executed before this configuration, for example: "dependsOn": ["first", "second"]. For more information, refer to Chained run configurations.

workingDir

Working directory for this run configuration.

allowParallelRun

When set to true, more than one instance of this configuration can run in parallel.

args

Maven command-line arguments. The value is a JSON array, for example, "args": ["--debug", "--fail-at-end"].

Default value: []

Example:

{ "name": "Run petclinic via maven", "type": "maven", "workingDir": "$PROJECT_DIR$", "tasks": [ "spring-boot:run", "-Dspring-boot.run.profiles=springProfile", "--activate-profiles", "mavenProfile_1" ] }

maven-run

Run JVM applications using Maven exec plugin commands

mainClass

(required)

Class with the main method to run. It will be passed to Maven via -Dexec.mainClass property.

environment

Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example:

"environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }

dependsOn

Names of other configurations which will be executed before this configuration, for example: "dependsOn": ["first", "second"]. For more information, refer to Chained run configurations.

workingDir

Working directory for this run configuration.

allowParallelRun

When set to true, more than one instance of this configuration can run in parallel.

args

Java application arguments. They will be passed to Maven via the-Dexec.args property. The value is a JSON array, for example, "args": ["I", "love", "Fleet"].

Default value: []

module

Maven project to build and run. A project can be specified with [groupId]:artifactId or with its relative path. It will be passed to maven via --projects command line argument.

Default value: ""

Example:

{ "name": "Run petclinic via maven", "type": "maven-run", "mainClass": "org.springframework.samples.petclinic.PetClinicApplication", "workingDir": "$PROJECT_DIR$" }

gradle

Run Gradle tasks

tasks

(required)

Gradle tasks to run. The value is a JSON array, for example, "tasks": ["clean", "build"].

environment

Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example:

"environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }

dependsOn

Names of other configurations which will be executed before this configuration, for example: "dependsOn": ["first", "second"]. For more information, refer to Chained run configurations.

workingDir

Working directory for this run configuration.

allowParallelRun

When set to true, more than one instance of this configuration can run in parallel.

args

Gradle command-line arguments. The value is a JSON array, for example, "args": ["--debug", "-PmyProp=myValue"].

Default value: []

initScripts

Gradle scripts to be 'injected' into Gradle execution for this configuration run. The value is a JSON structure ("temp file prefix" : "text script content"). For example: "initScripts": { "myInit": "allprojects { repositories { mavenLocal() } }" }.

Default value: {}

Example:

{ "name": "Build", "type": "gradle", "tasks": [ "build" ], "args": [ "--info" ] }

spring-boot

Spring Boot run configuration

mainClass

(required)

Class with the main() method

module

(required)

The module whose classpath should be used to run the application

environment

Custom environment variables for the process in the form of a JSON object. To define an environment variable, add a property, where the key is the variable name and the value is the value of the variable, for example:

"environment": { "TEMP_DIR": "/home/user/temp", "GENERATE_RANDOM_PASSWORD": "true" }

dependsOn

Names of other configurations which will be executed before this configuration, for example: "dependsOn": ["first", "second"]. For more information, refer to Chained run configurations.

workingDir

Working directory for this run configuration.

allowParallelRun

When set to true, more than one instance of this configuration can run in parallel.

activeProfiles

Active profiles in the form of a JSON array, for example, "activeProfiles": ["prod", "test", "dev"]

Default value: []

overriddenProperties

Override any configuration property. The value is a JSON array of objects, each object consisting of the enabled (true or false), name, and value keys.

Default value: []

args

Command-line arguments for your application. The value is a JSON array, for example, "args": ["I", "love", "Fleet"]

Default value: []

debugMode

Enable logging of the debug output. Equivalent of the debug Spring Core property.

Default value: false

enableLaunchOptimization

Enable the -XX:TieredStopAtLevel=1 and -noverify (only for JDK version 12 and earlier) options to speed up the application start-up.

Default value: true

hideBanner

Do not show the Spring banner in the command line. Equivalent of the spring.main.banner-mode=off property

Default value: false

options

JVM options in the form of a JSON array, for example, "options": [ "-Ddebug", "-ea"]

Default value: []

pty

Show application process output in PTY (true) or in read-only view (false)

Default value: true

Example:

{ "name": "Pet Clinic App", "type": "spring-boot", "dependsOn": [ "Build" ], "mainClass": "org.springframework.samples.petclinic.PetClinicApplication", "module": "spring-petclinic", "options": [ "-XX:TieredStopAtLevel=1", "-noverify", "-Dspring.output.ansi.enabled=always", "-Dfile.encoding=UTF-8" ], "activeProfiles": [ "PROFILE" ] }
Last modified: 21 February 2024