Version:

JLink packaging

The jlink extension produces a custom Java runtime image for a Quarkus application. The image contains only the JDK modules and application modules that are needed to run the application, resulting in a smaller, faster, and more self-contained distribution. This extension depends on the Quarkus modularity extension to compute the application’s module graph.

This technology is considered experimental.

In experimental mode, early feedback is requested to mature the idea. There is no guarantee of stability nor long term presence in the platform until the solution matures. Feedback is welcome on our mailing list or as issues in our GitHub issue tracker.

For a full list of possible statuses, check our FAQ entry.

Prerequisites

The jlink extension requires Java 25 or later. Earlier JDK versions have compatibility issues with the jlink tool that prevent reliable image generation.

Usage

Add the quarkus-jlink extension to your project. When the extension is present, a jlink image is produced automatically as part of the normal Quarkus build. JAR packaging is disabled when jlink is active.

CLI

quarkus extension add quarkus-jlink

Maven

./mvnw quarkus:add-extension -Dextensions='quarkus-jlink'

Gradle

./gradlew addExtension --extensions='quarkus-jlink'

After adding the extension, build the project normally:

CLI

quarkus build

Maven

./mvnw install

Gradle

./gradlew build

The jlink image is written to the output directory (by default, target/jlink-output/image).

Running the image

To run the application, execute the launcher script in the image’s bin directory:

./target/jlink-output/image/bin/<launcher-name>

The launcher name currently defaults to my-app. A future release will derive the default from quarkus.package.output-name.

Image layout

The output directory has the standard jlink image structure. The bin/ directory contains the launcher script. The lib/ directory contains the JDK runtime modules. Application modules that are not on the boot module path are placed in lib/quarkus/ and are loaded dynamically on demand after startup by smallrye-modules. See the modularity guide for an explanation of boot modules and dynamic modules.

Configuration reference

CDS support

Support for Class Data Sharing (CDS) and AOT precompilation within jlink images is planned for a future release.

CDS currently only applies to modules on the boot module path. Dynamic modules loaded by smallrye-modules are not eligible for CDS precompilation at this time.