--about-url url

URL of the application's home page.

--add-modules module[,module]

This module list, along with the main module (if specified) will be passed to jlink as the --add-module argument. If not specified, either just the main module (if module is specified), or the default set of modules (if mainJar is specified) are used.

Example:

<addModules>
    <module>module1</module>
    <module>module2</module>
</addModules>

Additional jpackage options not covered by dedicated plugin parameters.

Example:

<additionalOptions>
    <option>--jlink-options</option>
    <option>--bind-services</option>
</additionalOptions>

--app-content additional-content[,additional-content...]

A list of paths to files and/or directories to add to the application payload.

Example:

<appContentPaths>
    <path>./docs</path>
    <path>./images</path>
</appContentPaths>

--app-image directory

Location of the predefined application image that is used to build an installable package (on all platforms) or to be signed (on macOS).

--app-version version

Version of the application and/or package.

--arguments arguments

Command line arguments to pass to the main class if no command line arguments are given to the launcher.

Example:

<arguments>
    <argument>--help</argument>
</arguments>

--copyright copyright

Copyright for the application.

--description description

Description of the application.

--dest destination

Path where generated output file is placed.

See also removeDestination

--file-associations path

Path to a Properties file that contains list of key, value pairs.

Each property file is specified by a separate <fileAssociation> parameter.

Example:

<fileAssociations>
    <association>src/properties/java.properties</association>
    <association>src/properties/cpp.properties</association>
</fileAssociations>

--icon path

Path of the icon of the application package.

--input directory

Path of the input directory that contains the files to be packaged. All files in the input directory will be packaged into the application image.

--install-dir path

Absolute path of the installation directory of the application (on macOS or linux), or relative sub-path of the installation directory such as "Program Files" or "AppData" (on Windows).

--jlink-options options

A list of options to pass to jlink

If not specified, defaults to "--strip-native-commands --strip-debug --no-man-pages --no-header-files".

Example:

<jLinkOptions>
    <option>--strip-native-commands</option>
    <option>--strip-debug</option>
</jLinkOptions>

--java-options options

Options to pass to the Java runtime.

Example:

<javaOptions>
    <option>-XX:NewRatio=1</option>
    <option>-Xms100m</option>
    <option>-Xmx100m</option>
</javaOptions>

--launcher-as-service

Request to create an installer that will register the main application launcher as a background service-type application.

--add-launcher name=path

Name of launcher, and a path to a Properties file that contains a list of key, value pairs.

Example:

<launchers>
    <launcher>
        <name>name-of-the-launcher</name>
        <file>/path/to/launcher.properties</file>
    </launcher>
</launchers>

--license-file path

Path to the license file.

--linux-app-category category-value

Group value of the RPM <name>.spec file or Section value of DEB control file.

--linux-app-release release

Release value of the RPM <name>.spec file or Debian revision value of the DEB control file.

--linux-deb-maintainer email-address

Maintainer for .deb bundle.

--linux-menu-group menu-group-name

Menu group this application is placed in.

--linux-package-deps package-dep-string

Required packages or capabilities for the application.

--linux-package-name name

Name for Linux package.

--linux-rpm-license-type type

Type of the license ("License: value" of the RPM .spec)

--linux-shortcut

Creates a shortcut for the application.

--mac-app-category category

String used to construct LSApplicationCategoryType in application plist.

The default value is "utilities".

--mac-app-store

Indicates that the jpackage output is intended for the Mac App Store.

--mac-dmg-content additional-content[,additional-content...]

Include all the referenced content in the dmg.

Example:

<macDmgContentPaths>
    <path>./docs</path>
    <path>./images</path>
</macDmgContentPaths>

--mac-entitlements path

Path to file containing entitlements to use when signing executables and libraries in the bundle.

--mac-package-identifier identifier

An identifier that uniquely identifies the application for macOS.

Defaults to the main class name.

May only use alphanumeric (A-Z,a-z,0-9), hyphen (-), and period (.) characters.

--mac-package-name name

Name of the application as it appears in the Menu Bar.

This can be different from the application name.

This name must be less than 16 characters long and be suitable for displaying in the menu bar and the application Info window. Defaults to the application name.

--mac-package-signing-prefix prefix

When signing the application package, this value is prefixed to all components that need to be signed that don't have an existing package identifier.

--mac-sign

Request that the package or the predefined application image be signed.

--mac-signing-key-user-name name

Team or user name portion in Apple signing identities.

--mac-signing-keychain keychain-name

Name of the keychain to search for the signing identity.

If not specified, the standard keychains are used.

--main-class class-name

Qualified name of the application main class to execute.

--main-jar main-jar

The main JAR of the application; containing the main class (specified as a path relative to the input path).

--module module-name[/main-class]

The main module (and optionally main class) of the application.

This module must be located on the module path.

When this option is specified, the main module will be linked in the Java runtime image. Either module or mainJar option can be specified but not both.

--module-path module-path [,module-path...]

Each path is either a directory of modules or the path to a modular jar.

Example:

<modulePaths>
    <path>${project.build.directory}/mods</path>
</modulePaths>

--name name

Name of the application and/or package.

Remove destination directory.

Request to remove destination directory before executing jpackage.

jpackage utility fails if generated binary already exists. This option allows to overcome this behaviour. If true plugin will try to delete directory specified by destination. This might be useful to relaunch jpackage task without rebuilding an entire project.

For safety reasons plugin will not process removeDestination if destination points to a location outside of ${project.build.directory}.

--resource-dir path

Path to override jpackage resources. Icons, template files, and other resources of jpackage can be over-ridden by adding replacement resources to this directory.

--runtime-image path

For runtime image: Path of the predefined runtime image that will be copied into the application image.
If runtimeImage is not specified, jpackage will run jlink to create the runtime image using options specified by jLinkOptions.

For application package: Path of the predefined runtime image to install.
Option is required when creating a runtime installer.

Skips plugin execution.

--temp directory

Path of a new or empty directory used to create temporary files.

If specified, the temp dir will not be removed upon the task completion and must be removed manually.

If not specified, a temporary directory will be created and removed upon the task completion.

--type type

The type of package to create. Possible values:

Plugin	JPackage
APP_IMAGE	app-image
DMG	dmg
PKG	pkg
EXE	exe
MSI	msi
DEB	deb

--vendor vendor

Vendor of the application.

--verbose

Enables verbose output.

--win-console

Creates a console launcher for the application, should be specified for application which requires console interactions.

--win-dir-chooser

Adds a dialog to enable the user to choose a directory in which the product is installed.

--win-help-url url

URL where user can obtain further information or technical support.

--win-menu

Request to add a Start Menu shortcut for this application.

--win-menu-group menu group name

Start Menu group this application is placed in.

--win-per-user-install

Request to perform an installation on a per-user basis.

--win-shortcut

Request to create a desktop shortcut for this application.

--win-shortcut-prompt

Adds a dialog to enable the user to choose if shortcuts will be created by installer.

--win-update-url url

URL of available application update information.

--win-upgrade-uuid id

UUID associated with upgrades for this package.