JPACKAGE(1) JDK Commands JPACKAGE(1)

jpackage - tool for packaging self-contained Java applications.

jpackage [options]

Command-line options separated by spaces. See jpackage Options.

The jpackage tool will take as input a Java application and a Java run-time image, and produce a Java application image that includes all the necessary dependencies. It will be able to produce a native package in a platform-specific format, such as an exe on Windows or a dmg on macOS. Each format must be built on the platform it runs on, there is no cross-platform support. The tool will have options that allow packaged applications to be customized in various ways.

@filename
Read options from a file.

This option can be used multiple times.

The type of package to create

Valid values are: {"app-image", "exe", "msi", "rpm", "deb", "pkg", "dmg"}

If this option is not specified a platform dependent default type will be created.

Version of the application and/or package
Copyright for the application
Description of the application
Print the usage text with a list and description of each valid option for the current platform to the output stream, and exit.
Path of the icon of the application package

(absolute path or relative to the current directory)

Name of the application and/or package
Path where generated output file is placed

(absolute path or relative to the current directory).

Defaults to the current working directory.

Path to override jpackage resources

(absolute path or relative to the current directory)

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

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

(absolute path or relative to the current directory)

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.

Vendor of the application
Enables verbose output.
Print the product version to the output stream and exit.

A comma (",") separated list of modules to add

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 --main-jar is specified) are used.

This option can be used multiple times.

A File.pathSeparator separated list of paths

Each path is either a directory of modules or the path to a modular jar, and is absolute or relative to the current directory.

This option can be used multiple times.

A space separated list of options to pass to jlink

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

This option can be used multiple times.

Path of the predefined runtime image that will be copied into the application image

(absolute path or relative to the current directory)

If --runtime-image is not specified, jpackage will run jlink to create the runtime image using options specified by --jlink-options.

Path of the input directory that contains the files to be packaged

(absolute path or relative to the current directory)

All files in the input directory will be packaged into the application image.

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

This option can be used more than once.

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

(absolute path or relative to the current directory)

The keys "module", "main-jar", "main-class", "description", "arguments", "java-options", "icon", "launcher-as-service", "win-console", "win-shortcut", "win-menu", and "linux-shortcut" can be used.

These options are added to, or used to overwrite, the original command line options to build an additional alternative launcher. The main application launcher will be built from the command line options. Additional alternative launchers can be built using this option, and this option can be used multiple times to build multiple additional launchers.

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

This option can be used multiple times.

Options to pass to the Java runtime

This option can be used multiple times.

Qualified name of the application main class to execute

This option can only be used if --main-jar is specified.

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

Either --module or --main-jar option can be specified but not both.

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 --main-jar option can be specified but not both.

Windows platform options (available only when running on Windows):

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

macOS platform options (available only when running on macOS):

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.

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.

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.
Request that the package or the predefined application image be signed.
Name of the keychain to search for the signing identity

If not specified, the standard keychains are used.

Team or user name portion in Apple signing identities
Indicates that the jpackage output is intended for the Mac App Store.
Path to file containing entitlements to use when signing executables and libraries in the bundle
String used to construct LSApplicationCategoryType in application plist

The default value is "utilities".

URL of the application's home page
Location of the predefined application image that is used to build an installable package (on all platforms) or to be signed (on macOS)

(absolute path or relative to the current directory)

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

(absolute path or relative to the current directory)

The keys "extension", "mime-type", "icon", and "description" can be used to describe the association.

This option can be used multiple times.

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)
Path to the license file

(absolute path or relative to the current directory)

Path of the predefined runtime image to install

(absolute path or relative to the current directory)

Option is required when creating a runtime installer.

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

Windows platform options (available only when running on Windows):

Adds a dialog to enable the user to choose a directory in which the product is installed.
URL where user can obtain further information or technical support
Request to add a Start Menu shortcut for this application
Start Menu group this application is placed in
Request to perform an install on a per-user basis
Request to create a desktop shortcut for this application
Adds a dialog to enable the user to choose if shortcuts will be created by installer
URL of available application update information
UUID associated with upgrades for this package

Name for Linux package

Defaults to the application name.

Maintainer for .deb bundle
Menu group this application is placed in
Required packages or capabilities for the application
Type of the license ("License: value" of the RPM .spec)
Release value of the RPM <name>.spec file or Debian revision value of the DEB control file
Group value of the RPM <name>.spec file or Section value of DEB control file
Creates a shortcut for the application.

macOS platform options (available only when running on macOS):

Include all the referenced content in the dmg.

This option can be used more than once.

Generate an application package suitable for the host system:

For a modular application:
    jpackage -n name -p modulePath -m moduleName/className
For a non-modular application:
    jpackage -i inputDir -n name \
        --main-class className --main-jar myJar.jar
From a pre-built application image:
    jpackage -n name --app-image appImageDir

Generate an application image:

For a modular application:
    jpackage --type app-image -n name -p modulePath \
        -m moduleName/className
For a non-modular application:
    jpackage --type app-image -i inputDir -n name \
        --main-class className --main-jar myJar.jar
To provide your own options to jlink, run jlink separately:
    jlink --output appRuntimeImage -p modulePath \
        --add-modules moduleName \
        --no-header-files [<additional jlink options>...]
    jpackage --type app-image -n name \
        -m moduleName/className --runtime-image appRuntimeImage

Generate a Java runtime package:

jpackage -n name --runtime-image <runtime-image>

Sign the predefined application image (on macOS):

jpackage --type app-image --app-image <app-image> \
    --mac-sign [<additional signing options>...]
Note: the only additional options that are permitted in this mode are:
      the set of additional mac signing options and --verbose

jpackage will use jlink to create Java Runtime unless the --runtime-image option is used. The created Java Runtime image on Windows will include MS runtime libraries bundled with the JDK. If MS runtime libraries of a different version are needed for the application, the user will need to add/replace those themselves.

Icons, template files, and other resources of jpackage can be over-ridden by adding replacement resources to this directory. jpackage will lookup files by specific names in the resource directory.

<launcher-name>.png
Application launcher icon

Default resource is JavaApp.png

<launcher-name>.desktop
A desktop file to be used with xdg-desktop-menu command

Considered with application launchers registered for file associations and/or have an icon

Default resource is template.desktop

<package-name>-<launcher-name>.service
systemd unit file for application launcher registered as a background service-type application

Default resource is unit-template.service

<package-name>.spec
RPM spec file

Default resource is template.spec

Control file

Default resource is template.control

Copyright file

Default resource is template.copyright

Pre-install shell script

Default resource is template.preinstall

Pre-remove shell script

Default resource is template.prerm

Post-install shell script

Default resource is template.postinstall

Post-remove shell script

Default resource is template.postrm

<launcher-name>.ico
Application launcher icon

Default resource is JavaApp.ico

<launcher-name>.properties
Properties file for application launcher executable

Default resource is WinLauncher.template

<application-name>-post-image.wsf
A Windows Script File (WSF) to run after building application image
Main WiX project file

Default resource is main.wxs

Overrides WiX project file

Default resource is overrides.wxi

Service installer executable

Considered if some application launchers are registered as background service-type applications

<launcher-name>-service-install.wxi
Service installer WiX project file

Considered if some application launchers are registered as background service-type applications

Default resource is service-install.wxi

<launcher-name>-service-config.wxi
Service installer WiX project file

Considered if some application launchers are registered as background service-type applications

Default resource is service-config.wxi

WiX project file for installer UI dialog checking installation directory doesn't exist or is empty

Default resource is InstallDirNotEmptyDlg.wxs

WiX project file for installer UI dialog configuring shortcuts

Default resource is ShortcutPromptDlg.wxs

WiX project file with the hierarchy of components of application image
WiX project file for installer UI
WiX source code converter. Used for converting WiX sources from WiX v3 to v4 schema when WiX v4 or newer is used

Default resource is wix3-to-wix4-conv.xsl

Properties file for the installer executable

Default resource is WinInstaller.template

<package-name>-post-msi.wsf
A Windows Script File (WSF) to run after building embedded MSI installer for EXE installer

<launcher-name>.icns
Application launcher icon

Default resource is JavaApp.icns

Application property list file

Default resource is Info-lite.plist.template

Java Runtime property list file

Default resource is Runtime-Info.plist.template

<application-name>.entitlements
Signing entitlements property list file

Default resource is sandbox.plist

<package-name>-post-image.sh
Shell script to run after building application image

Uninstaller shell script

Considered if some application launchers are registered as background service-type applications

Default resource is uninstall.command.template

Pre-install shell script

Default resource is preinstall.template

Post-install shell script

Default resource is postinstall.template

Pre-install shell script for services package

Considered if some application launchers are registered as background service-type applications

Default resource is services-preinstall.template

Post-install shell script for services package

Considered if some application launchers are registered as background service-type applications

Default resource is services-postinstall.template

<package-name>-background.png
Background image

Default resource is background_pkg.png

<package-name>-background-darkAqua.png
Dark background image

Default resource is background_pkg.png

Package property list file

Default resource is product-def.plist

<package-name>-<launcher-name>.plist
launchd property list file for application launcher registered as a background service-type application

Default resource is launchd.plist.template

<package-name>-dmg-setup.scpt
Setup AppleScript script

Default resource is DMGsetup.scpt

<package-name>-license.plist
License property list file

Default resource is lic_template.plist

<package-name>-background.tiff
Background image

Default resource is background_dmg.tiff

<package-name>-volume.icns
Volume icon

Default resource is JavaApp.icns

2025 JDK 24.0.1