Plugin Quarkus Maven
The Quarkus Maven Plugin builds the Quarkus applications, and provides helpers to launch dev mode or build native executables. For more information about how to use the Quarkus Maven Plugin, please refer to the Maven Tooling guide.
Descubre los objetivos de Maven
Like most Maven plugins, the Quarkus Maven Plugin has a help goal that prints the description of the plugin, listing all available goals as well as their description.
It is also possible to print out detailed information about a goal, all its parameters and their default values. For instance, to see the help for the create goal, run:
./mvnw quarkus:help -Ddetail -Dgoal=create
Referencia de los objetivos de Maven
Aquí está la lista de todos los objetivos de Quarkus Maven Plugin:
quarkus:add-extension
Allow adding an extension to an existing pom.xml file. Because you can add one or several extension in one go, there are 2 mojos: add-extensions and add-extension. Both supports the extension and extensions parameters.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
String |
||
Set |
||
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:add-extensions
Allow adding extensions to an existing pom.xml file. Because you can add one or several extension in one go, there are 2 mojos: add-extensions and add-extension. Both supports the extension and extensions parameters.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
String |
||
Set |
||
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:analyze-call-tree
Analyze call tree of a method or a class based on an existing report produced by Substrate when using -H:+PrintAnalysisCallTree, and does a more meaningful analysis of what is causing a type to be retained.
Tipo |
Por defecto |
|
|---|---|---|
String |
|
|
String |
|
|
File |
|
quarkus:build
Builds the Quarkus application.
Tipo |
Por defecto |
|
|---|---|---|
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. Show more |
String |
|
File |
|
|
boolean |
||
String |
|
|
File |
|
|
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: `<configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration> ` Show more |
java.lang.String[] |
|
Map |
||
List |
||
MojoExecution |
|
|
The project’s remote repositories to use for the resolution of plugins and their dependencies. Show more |
List |
|
MavenProject |
|
|
Map |
||
RepositorySystemSession |
|
|
The project’s remote repositories to use for the resolution of artifacts and their dependencies. Show more |
List |
|
MavenSession |
|
|
boolean |
|
|
boolean |
|
|
Map |
quarkus:create
This goal helps in setting up Quarkus Maven project with quarkus-maven-plugin, with sensible defaults
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
String |
||
String |
|
|
The Show more |
String |
|
String |
||
String |
||
Set |
||
String |
||
boolean |
|
|
File |
|
|
Set the package name of the generated classes.
If not set, Show more |
String |
|
The Show more |
String |
|
MavenProject |
|
|
String |
||
String |
||
String |
||
String |
||
String |
||
RepositorySystemSession |
|
|
List |
|
|
MavenSession |
|
quarkus:create-extension
Creates the base of a Quarkus Extension in different layout depending on the options and environment.
Create in the quarkus-parent project directory (or the extensions parent dir)
It will:
- generate the new Quarkus extension in the extensions parent as a module (parent, runtime and deployment), with unit test and devmode test on option.
- On option, generate the new integration test in the integration tests parent as a module.
- add the dependencies to the bom/application/pom.xml.
Creating a Quarkiverse extension
When using -DgroupId=io.quarkiverse.[featureId], the new extension will use the Quarkiverse layout.
Creating a standalone extension
-
generate the new Quarkus extension in the current directory (parent, runtime and deployment), with unit test and devmode test on option.
-
On option, generate the new integration test module in the current directory.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
Directory where the changes should be performed. Default: the current directory of the current Java process. Show more |
File |
|
The This description is used on https://code.quarkus.io/. Show more |
String |
|
It will be used to generate the different extension modules artifactIds ( Show more |
String |
|
The Default: the formatted Show more |
String |
|
The Show more |
String |
|
A prefix common to all extension artifactIds in the current source tree. Default: "quarkus-" in quarkus Quarkus Core and Quarkiverse else "" Show more |
String |
|
A prefix common to all extension names in the current source tree. Default: "quarkus-" in Quarkus Core and Quarkiverse else "" Show more |
String |
|
Base package under which classes should be created in Runtime and Deployment modules. Default: auto-generated out of Show more |
String |
|
MavenProject |
|
|
The Default: Show more |
String |
|
The Default: Show more |
String |
|
The Default: Show more |
String |
|
Quarkus version the newly created extension should depend on (REQUIRED - INHERITED IN QUARKUS-CORE). Show more |
String |
|
MavenSession |
|
|
The Default: automatic in Quarkus Core else Show more |
String |
|
boolean |
|
|
boolean |
|
|
Indicates whether to generate an integration tests for the extension Show more |
boolean |
|
Indicates whether to generate any tests for the extension (same as Show more |
boolean |
|
boolean |
|
quarkus:create-jbang
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
Set |
||
String |
||
boolean |
|
|
File |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:dependency-tree
Displays Quarkus application build dependency tree including the deployment ones.
Tipo |
Por defecto |
|
|---|---|---|
boolean |
|
|
Target launch mode corresponding to Show more |
String |
|
If specified, this parameter will cause the dependency tree to be written to the path specified, instead of writing to the console. Show more |
File |
|
MavenProject |
|
|
List |
|
quarkus:dev
The dev mojo, that runs a quarkus app in a forked process. A background compilation process is launched and any changes are automatically reflected in your running application.
You can use this dev mode in a remote container environment with remote-dev.
Tipo |
Por defecto |
|
|---|---|---|
String |
|
|
File |
|
|
Additional parameters to pass to javac when recompiling changed source files. Show more |
List |
|
List |
||
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 Show more |
String |
|
String |
|
|
String |
|
|
boolean |
|
|
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. Show more |
boolean |
|
Map |
||
String |
|
|
Allows configuring the modules to add to the application. The listed modules will be added using: Show more |
List |
|
MojoExecution |
|
|
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. Show more |
boolean |
|
boolean |
|
|
File |
|
|
List |
|
|
This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the Show more |
boolean |
|
MavenProject |
|
|
String |
|
|
RepositorySystemSession |
|
|
List |
|
|
MavenSession |
|
|
String |
|
|
File |
|
|
Whether the JVM launch, in debug mode, should be suspended. This parameter is only relevant when the JVM is launched in Show more |
String |
|
Map |
||
String |
|
|
File |
quarkus:generate-code
Tipo |
Por defecto |
|
|---|---|---|
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. Show more |
String |
|
File |
|
|
boolean |
||
String |
|
|
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: `<configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration> ` Show more |
java.lang.String[] |
|
Map |
||
List |
||
String |
|
|
MojoExecution |
|
|
MavenProject |
|
|
Map |
||
RepositorySystemSession |
|
|
The project’s remote repositories to use for the resolution of artifacts and their dependencies. Show more |
List |
|
MavenSession |
|
|
boolean |
|
quarkus:generate-code-tests
Tipo |
Por defecto |
|
|---|---|---|
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. Show more |
String |
|
File |
|
|
boolean |
||
String |
|
|
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: `<configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration> ` Show more |
java.lang.String[] |
|
Map |
||
List |
||
String |
|
|
MojoExecution |
|
|
MavenProject |
|
|
Map |
||
RepositorySystemSession |
|
|
The project’s remote repositories to use for the resolution of artifacts and their dependencies. Show more |
List |
|
MavenSession |
|
|
boolean |
|
quarkus:go-offline
This goal downloads all the Maven artifact dependencies required to build, run, test and launch the application dev mode.
Tipo |
Por defecto |
|
|---|---|---|
Target launch mode corresponding to Show more |
String |
|
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:help
Display help information on quarkus-maven-plugin.
Call mvn quarkus:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
Tipo |
Por defecto |
|
|---|---|---|
boolean |
|
|
The name of the goal for which to show help. If unspecified, all goals will be displayed. Show more |
String |
|
int |
|
|
int |
|
quarkus:image-build
Builds a container image.
Tipo |
Por defecto |
|
|---|---|---|
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. Show more |
String |
|
File |
|
|
Builder |
|
|
boolean |
||
boolean |
|
|
String |
|
|
File |
|
|
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: `<configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration> ` Show more |
java.lang.String[] |
|
Map |
||
List |
||
MojoExecution |
|
|
The project’s remote repositories to use for the resolution of plugins and their dependencies. Show more |
List |
|
MavenProject |
|
|
Map |
||
RepositorySystemSession |
|
|
The project’s remote repositories to use for the resolution of artifacts and their dependencies. Show more |
List |
|
MavenSession |
|
|
boolean |
|
|
boolean |
|
|
Map |
quarkus:image-push
Pushes a container image.
Tipo |
Por defecto |
|
|---|---|---|
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. Show more |
String |
|
File |
|
|
Builder |
|
|
boolean |
||
boolean |
|
|
String |
|
|
File |
|
|
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: `<configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration> ` Show more |
java.lang.String[] |
|
Map |
||
List |
||
MojoExecution |
|
|
The project’s remote repositories to use for the resolution of plugins and their dependencies. Show more |
List |
|
MavenProject |
|
|
Map |
||
RepositorySystemSession |
|
|
The project’s remote repositories to use for the resolution of artifacts and their dependencies. Show more |
List |
|
MavenSession |
|
|
boolean |
|
|
boolean |
|
|
Map |
quarkus:info
Log Quarkus-specific project information, such as imported Quarkus platform BOMs, Quarkus extensions found among the project dependencies, etc.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
If true, the information will be logged per each relevant module of the project instead of an overall summary Show more |
boolean |
|
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:list-categories
List extension categories, which a user can use to filter extensions.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
Select the output format among 'name' (display the name only) and 'full' (includes a verbose name and a description). Show more |
String |
|
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:list-extensions
List the available extensions. You can add one or several extensions in one go, with the 2 following mojos: add-extensions and add-extension. You can list all extension or just installable. Choose between 3 output formats: name, concise and full.
Tipo |
Por defecto |
|
|---|---|---|
boolean |
|
|
String |
||
String |
||
String |
||
String |
||
Select the output format among 'id' (display the artifactId only), 'concise' (display name and artifactId) and 'full' (concise format and version related columns). Show more |
String |
|
boolean |
|
|
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
|
String |
quarkus:list-platforms
List imported and optionally other platforms available for the project.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
boolean |
|
|
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:prepare
Tipo |
Por defecto |
|
|---|---|---|
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. Show more |
String |
|
File |
|
|
boolean |
||
String |
|
|
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: `<configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration> ` Show more |
java.lang.String[] |
|
Map |
||
List |
||
String |
|
|
MojoExecution |
|
|
MavenProject |
|
|
Map |
||
RepositorySystemSession |
|
|
The project’s remote repositories to use for the resolution of artifacts and their dependencies. Show more |
List |
|
MavenSession |
|
|
boolean |
|
quarkus:prepare-tests
Tipo |
Por defecto |
|
|---|---|---|
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. Show more |
String |
|
File |
|
|
boolean |
||
String |
|
|
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: `<configuration> <uberJar>true</uberJar> <ignoredEntries> <ignoredEntry>META-INF/BC2048KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC2048KE.DSA</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.SF</ignoredEntry> <ignoredEntry>META-INF/BC1024KE.DSA</ignoredEntry> </ignoredEntries> </configuration> ` Show more |
java.lang.String[] |
|
Map |
||
List |
||
String |
|
|
MojoExecution |
|
|
MavenProject |
|
|
Map |
||
RepositorySystemSession |
|
|
The project’s remote repositories to use for the resolution of artifacts and their dependencies. Show more |
List |
|
MavenSession |
|
|
boolean |
|
quarkus:remote-dev
The dev mojo, that connects to a remote host.
Tipo |
Por defecto |
|
|---|---|---|
String |
|
|
File |
|
|
Additional parameters to pass to javac when recompiling changed source files. Show more |
List |
|
List |
||
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 Show more |
String |
|
String |
|
|
String |
|
|
boolean |
|
|
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. Show more |
boolean |
|
Map |
||
String |
|
|
Allows configuring the modules to add to the application. The listed modules will be added using: Show more |
List |
|
MojoExecution |
|
|
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. Show more |
boolean |
|
boolean |
|
|
File |
|
|
List |
|
|
This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the Show more |
boolean |
|
MavenProject |
|
|
String |
|
|
RepositorySystemSession |
|
|
List |
|
|
MavenSession |
|
|
String |
|
|
File |
|
|
Whether the JVM launch, in debug mode, should be suspended. This parameter is only relevant when the JVM is launched in Show more |
String |
|
Map |
||
String |
|
|
File |
quarkus:remove-extension
Allow removing an extension from an existing pom.xml file. Because you can remove one or several extension in one go, there are 2 mojos: remove-extensions and remove-extension. Both supports the extension and extensions parameters.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
String |
||
Set |
||
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:remove-extensions
Allow removing extensions to an existing pom.xml file. Because you can remove one or several extension in one go, there are 2 mojos: remove-extensions and remove-extension. Both supports the extension and extensions parameters.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
String |
||
Set |
||
MavenProject |
|
|
RepositorySystemSession |
|
|
List |
|
quarkus:test
The test mojo, that starts continuous testing outside of dev mode
Tipo |
Por defecto |
|
|---|---|---|
String |
|
|
File |
|
|
Additional parameters to pass to javac when recompiling changed source files. Show more |
List |
|
List |
||
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 Show more |
String |
|
String |
|
|
String |
|
|
boolean |
|
|
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. Show more |
boolean |
|
Map |
||
String |
|
|
Allows configuring the modules to add to the application. The listed modules will be added using: Show more |
List |
|
MojoExecution |
|
|
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. Show more |
boolean |
|
boolean |
|
|
File |
|
|
List |
|
|
This value is intended to be set to true when some generated bytecode is erroneous causing the JVM to crash when the Show more |
boolean |
|
MavenProject |
|
|
String |
|
|
RepositorySystemSession |
|
|
List |
|
|
MavenSession |
|
|
String |
|
|
File |
|
|
Whether the JVM launch, in debug mode, should be suspended. This parameter is only relevant when the JVM is launched in Show more |
String |
|
Map |
||
String |
|
|
File |
quarkus:update
Log Quarkus-related recommended updates, such as new Quarkus platform BOM versions and Quarkus extensions versions that aren’t managed by the Quarkus platform BOMs.
Tipo |
Por defecto |
|
|---|---|---|
String |
||
String |
||
String |
||
If true, the information will be logged per each relevant module of the project instead of an overall summary Show more |
boolean |
|
MavenProject |
|
|
If true, the state of the project will be logged as if the recommended updates were applied Show more |
boolean |
|
If true, instead of checking and recommending the latest available Quarkus platform version, recommendations to properly align the current project configuration will be logged (if any) Show more |
boolean |
|
RepositorySystemSession |
|
|
List |
|