Chapter 3. Creating a Quarkus project on the command line

Procedure

1. In a command terminal, enter the following command to verify that Maven is using JDK 11 and that the Maven version is 3.6.2 or higher:

   mvn --version

   Copy to Clipboard Toggle word wrap
2. If the preceding command does not return JDK 11, add the path to JDK 11 to the PATH environment variable and enter the preceding command again.

3. To use the Quarkus Maven plug-in to create a new project, use one of the following methods:

   • Enter the following command:

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create \
         -DprojectGroupId=<project_group_id> \
         -DprojectArtifactId=<project_artifact_id> \
         -DplatformGroupId=com.redhat.quarkus \
         -DplatformArtifactId=quarkus-universe-bom \
         -DplatformVersion=1.11.7.Final-redhat-00009 \
         -DclassName="<classname>"

     Copy to Clipboard Toggle word wrap

     In this command, replace the following values:

     • <project_group_id>: A unique identifier of your project
     • <project_artifact_id>: The name of your project and your project directory
     • <classname>: The fully qualified name of the generated resource, for example org.acme.quarkus.sample.HelloResource

   • Create the project in interactive mode:

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create

     Copy to Clipboard Toggle word wrap

     When prompted, enter the required attribute values.

     Note

     Alternatively, you can create your project using the default values for the project attributes by entering the following command:

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create -B

     The following table lists the attributes that you can define with the create command:

     Expand

     Attribute	Default Value	Description
     projectGroupId	org.acme.sample	A unique identifier of your project.
     projectArtifactId	none	The name of your project and your project directory. If you do not specify the projectArtifactId, the Maven plug-in starts the interactive mode. If the directory already exists, the generation fails.
     projectVersion	1.0-SNAPSHOT	The version of your project.
     platformGroupId	io.quarkus	The group id of your platform. All the existing platforms are provided by io.quarkus. However, you can change the default value.
     platformArtifactId	quarkus-universe-bom	The artifact id of your platform BOM. To use the locally built Quarkus add quarkus-universe-bom to your pom.xml file.
     platformVersion	The latest platform version	The version of the platform you want to use for your project. You can provide a version range and the Maven plug-in uses the latest version.
     className	None	The fully qualified name of the generated resource. After the application is created, the REST endpoint is exposed at the following URL: http://localhost:8080/$path If you use the default path, the URL is http://localhost:8080/hello.
     path	/hello	The resource path, only if you set the className.
     extensions	[]	The list of extensions you want to add to your project separated by comma.

     Show more