Quarkus Maven Plugin

For usability reason, this parameter allows adding a single extension.

The list of extensions to be added.

For usability reason, this parameter allows adding a single extension.

The list of extensions to be added.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

The directory for generated source files.

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The project’s remote repositories to use for the resolution of plugins and their dependencies.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skips the execution of this mojo

The list of system properties defined for the plugin.

Artifact ID of the target platform BOM

Group ID of the target platform BOM

Version of the target platform BOM

The className will define the generated class names when picking only one of those extensions resteasy, resteasy-reactive and spring-web. If more than one of those extensions are picked, then only the package name part will be used as packageName More info: https://github.com/quarkusio/quarkus/issues/14437 By default, the projectGroupId is used as package for generated classes (you can also use packageName to have them different). className

When true, do not include any code in the generated Quarkus project.

Set the package name of the generated classes. If not set, projectGroupId will be used as packageName packageName

The path will define the REST path of the generated code when picking only one of those extensions resteasy, resteasy-reactive and spring-web. If more than one of those extensions are picked, this parameter will be ignored. More info: https://github.com/quarkusio/quarkus/issues/14437 className

Used to detect legacy command usage and display an error

Directory where the changes should be performed. Default: the current directory of the current Java process.

The extensionDescription of the runtime module. This description is used on https://code.quarkus.io/.

extensionId of this extension (REQUIRED). It will be used to generate the different extension modules artifactIds ([namespaceId][extensionId]-parent), runtime ([namespaceId][extensionId]) and deployment ([namespaceId][extensionId]-deployment).

The extensionName of the runtime module. The extensionNames of the extension parent and deployment modules will be based on this name too. Default: the formatted extensionId

The groupId for the newly created Maven modules (REQUIRED - INHERITED IN QUARKUS-CORE).

A prefix common to all extension artifactIds in the current source tree. Default: "quarkus-" in quarkus Quarkus Core and Quarkiverse else ""

A prefix common to all extension names in the current source tree. Default: "quarkus-" in Quarkus Core and Quarkiverse else ""

Base package under which classes should be created in Runtime and Deployment modules. Default: auto-generated out of groupId, namespaceId and extensionId

The artifactId of the Quarkus platform BOM. Default: io.quarkus.devtools.commands.CreateExtension.DEFAULT_BOM_ARTIFACT_ID

The groupId of the Quarkus platform BOM. Default: io.quarkus.devtools.commands.CreateExtension.DEFAULT_BOM_GROUP_ID

The version of the Quarkus platform BOM. Default: io.quarkus.devtools.commands.CreateExtension.DEFAULT_BOM_VERSION

Quarkus version the newly created extension should depend on (REQUIRED - INHERITED IN QUARKUS-CORE).

The version for the newly created Maven modules. Default: automatic in Quarkus Core else io.quarkus.devtools.commands.CreateExtension.DEFAULT_VERSION

Indicates whether to generate an extension codestart

Indicates whether to generate a devmode test for the extension

Indicates whether to generate an integration tests for the extension

Indicates whether to generate any tests for the extension (same as -DwithoutUnitTest -DwithoutIntegrationTest -DwithoutDevModeTest)

Indicates whether to generate a unit test class for the extension

Artifact ID of the target platform BOM

Group ID of the target platform BOM

Version of the target platform BOM

Whether to append outputs into the output file or overwrite it.

Target launch mode corresponding to io.quarkus.runtime.LaunchMode for which the dependency tree should be built. io.quarkus.runtime.LaunchMode.NORMAL is the default.

If specified, this parameter will cause the dependency tree to be written to the path specified, instead of writing to the console.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

The directory for generated source files.

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The project’s remote repositories to use for the resolution of plugins and their dependencies.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skips the execution of this mojo

The list of system properties defined for the plugin.

Additional parameters to pass to javac when recompiling changed source files.

Additional compiler arguments

If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. debug supports the following options: Value Effect false The JVM is not started in debug mode true The JVM is started in debug mode and will be listening on debugHost:debugPort client The JVM is started in client mode, and will attempt to connect to debugHost:debugPort {port} The JVM is started in debug mode and will be listening on debugHost:{port}. By default, debugHost has the value "localhost", and debugPort is 5005.

Whether to enforce the quarkus-maven-plugin build goal to be configured. By default, a missing build goal is considered an inconsistency (although the build goal is not required technically). In this case a warning will be logged and the application will not be started.

Allows configuring the modules to add to the application. The listed modules will be added using: --add-modules m1,m2…​.

Whether changes in the projects that appear to be dependencies of the project containing the application to be launched should trigger hot-reload. By default, they do.

The directory for compiled classes.

This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the verify:none option is set (which is on by default)

The --release argument to javac.

The -source argument to javac.

Whether the JVM launch, in debug mode, should be suspended. This parameter is only relevant when the JVM is launched in debug mode. This parameter supports the following values (all the allowed values are case-insensitive): Value Effect y or true The debug mode JVM launch is suspended n or false The debug mode JVM is started without suspending

The -target argument to javac.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skip the execution of this mojo

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skip the execution of this mojo

Target launch mode corresponding to io.quarkus.runtime.LaunchMode for which the dependencies should be resolved. io.quarkus.runtime.LaunchMode.TEST is the default, since it includes both provided and test dependency scopes.

If true, display all settable properties for each goal.

The name of the goal for which to show help. If unspecified, all goals will be displayed.

The number of spaces per indentation level, should be positive.

The maximum length of a display line, should be positive.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

The directory for generated source files.

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The project’s remote repositories to use for the resolution of plugins and their dependencies.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skips the execution of this mojo

The list of system properties defined for the plugin.

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

The directory for generated source files.

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The project’s remote repositories to use for the resolution of plugins and their dependencies.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skips the execution of this mojo

The list of system properties defined for the plugin.

If true, the information will be logged per each relevant module of the project instead of an overall summary

Select the output format among 'name' (display the name only) and 'full' (includes a verbose name and a description).

List all extensions or just the installable.

Only list extensions from given category.

Select the output format among 'id' (display the artifactId only), 'concise' (display name and artifactId) and 'full' (concise format and version related columns).

List the already installed extensions

Search filter on extension list. The format is based on Java Pattern.

List the already installed extensions

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skip the execution of this mojo

Coordinates of the Maven artifact containing the original Java application to build the native image for. If not provided, the current project is assumed to be the original Java application. The coordinates are expected to be expressed in the following format: groupId:artifactId:classifier:type:version With the classifier, type and version being optional. If the type is missing, the artifact is assumed to be of type JAR. If the version is missing, the artifact is going to be looked up among the project dependencies using the provided coordinates. However, if the expression consists of only three parts, it is assumed to be groupId:artifactId:version. If the expression consists of only four parts, it is assumed to be groupId:artifactId:classifier:type.

Whether to close the bootstrapped applications after the execution

When building an uber-jar, this array specifies entries that should be excluded from the final jar. The entries are relative to the root of the file. An example of this configuration could be: true META-INF/BC2048KE.SF META-INF/BC2048KE.DSA META-INF/BC1024KE.SF META-INF/BC1024KE.DSA

The list of main manifest attributes

The list of manifest sections

The context of the execution of the plugin.

The properties of the plugin.

The current repository/network configuration of Maven.

The project’s remote repositories to use for the resolution of artifacts and their dependencies.

Skip the execution of this mojo

Additional parameters to pass to javac when recompiling changed source files.

Additional compiler arguments

If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. debug supports the following options: Value Effect false The JVM is not started in debug mode true The JVM is started in debug mode and will be listening on debugHost:debugPort client The JVM is started in client mode, and will attempt to connect to debugHost:debugPort {port} The JVM is started in debug mode and will be listening on debugHost:{port}. By default, debugHost has the value "localhost", and debugPort is 5005.

Whether to enforce the quarkus-maven-plugin build goal to be configured. By default, a missing build goal is considered an inconsistency (although the build goal is not required technically). In this case a warning will be logged and the application will not be started.

Allows configuring the modules to add to the application. The listed modules will be added using: --add-modules m1,m2…​.

Whether changes in the projects that appear to be dependencies of the project containing the application to be launched should trigger hot-reload. By default, they do.

The directory for compiled classes.

This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the verify:none option is set (which is on by default)

The --release argument to javac.

The -source argument to javac.

Whether the JVM launch, in debug mode, should be suspended. This parameter is only relevant when the JVM is launched in debug mode. This parameter supports the following values (all the allowed values are case-insensitive): Value Effect y or true The debug mode JVM launch is suspended n or false The debug mode JVM is started without suspending

The -target argument to javac.

For usability reason, this parameter allows removing a single extension.

The list of extensions to be removed.

For usability reason, this parameter allows removing a single extension.

The list of extensions to be removed.

Additional parameters to pass to javac when recompiling changed source files.

Additional compiler arguments

If this server should be started in debug mode. The default is to start in debug mode and listen on port 5005. Whether the JVM is suspended waiting for a debugger to be attached, depends on the value of suspend. debug supports the following options: Value Effect false The JVM is not started in debug mode true The JVM is started in debug mode and will be listening on debugHost:debugPort client The JVM is started in client mode, and will attempt to connect to debugHost:debugPort {port} The JVM is started in debug mode and will be listening on debugHost:{port}. By default, debugHost has the value "localhost", and debugPort is 5005.

Whether to enforce the quarkus-maven-plugin build goal to be configured. By default, a missing build goal is considered an inconsistency (although the build goal is not required technically). In this case a warning will be logged and the application will not be started.

Allows configuring the modules to add to the application. The listed modules will be added using: --add-modules m1,m2…​.

Whether changes in the projects that appear to be dependencies of the project containing the application to be launched should trigger hot-reload. By default, they do.

The directory for compiled classes.

This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the verify:none option is set (which is on by default)

The --release argument to javac.

The -source argument to javac.

Whether the JVM launch, in debug mode, should be suspended. This parameter is only relevant when the JVM is launched in debug mode. This parameter supports the following values (all the allowed values are case-insensitive): Value Effect y or true The debug mode JVM launch is suspended n or false The debug mode JVM is started without suspending

The -target argument to javac.

Disable the rewrite feature.

Display information per project module.

Version of the target platform (e.g: 2.0.0.Final) You may instead use streamId to target the latest version of a specific platform stream.

Rewrite in dry-mode.

The OpenRewrite plugin version

The io.quarkus:quarkus-update-recipes version. This artifact contains the base recipes used by this tool to update a project.

Target stream (e.g: 2.0)