Name
jpackage - tool for packaging self-contained Java applications.
Synopsis
jpackage
[options]
- options
- Command-line options separated by spaces. See jpackage Options.
Description
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.
jpackage Options
Generic Options:
@
filenameRead options from a file.
This option can be used multiple times.
--type
or-t
typeThe 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.
--app-version
versionVersion of the application and/or package
--copyright
copyrightCopyright for the application
--description
descriptionDescription of the application
--help
or-h
Print the usage text with a list and description of each valid option for the current platform to the output stream, and exit.
--icon
pathPath of the icon of the application package
(absolute path or relative to the current directory)
--name
or-n
nameName of the application and/or package
--dest
or-d
destinationPath where generated output file is placed
(absolute path or relative to the current directory).
Defaults to the current working directory.
--temp
directoryPath 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
vendorVendor of the application
--verbose
Enables verbose output.
--version
Print the product version to the output stream and exit.
Options for creating the runtime image:
--add-modules
module-name [,
module-name...]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.
--module-path
or-p
module-path [,
module-path...]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.
--jlink-options
optionsA 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.
--runtime-image
directoryPath 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.
Options for creating the application image:
--input
or-i
directoryPath 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.
- `--app-content additional-content[,additional-content...]
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.
Options for creating the application launcher(s):
--add-launcher
name=pathName 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", "arguments", "java-options", "app-version", "icon", "win-console", "win-shortcut", "win-menu", "linux-app-category", 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.
--arguments
argumentsCommand 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.
--java-options
optionsOptions to pass to the Java runtime
This option can be used multiple times.
--main-class
class-nameQualified name of the application main class to execute
This option can only be used if --main-jar is specified.
--main-jar
main-jarThe 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.
--module
or-m
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 --main-jar option can be specified but not both.
Platform dependent option for creating the application launcher:
Windows platform options (available only when running on Windows):
--win-console
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):
--mac-package-identifier
identifierAn identifier that uniquely identifies the application for macOS
Defaults to the the main class name.
May only use alphanumeric (A-Z,a-z,0-9), hyphen (-), and period (.) characters.
--mac-package-name
nameName 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
prefixWhen 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 bundle be signed.
--mac-signing-keychain
keychain-nameName of the keychain to search for the signing identity
If not specified, the standard keychains are used.
--mac-signing-key-user-name
nameTeam or user name portion in Apple signing identities
--mac-app-store
Indicates that the jpackage output is intended for the Mac App Store.
--mac-entitlements
pathPath to file containing entitlements to use when signing executables and libraries in the bundle
--mac-app-category
categoryString used to construct LSApplicationCategoryType in application plist
The default value is "utilities".
Options for creating the application package:
--about-url
urlURL of the application's home page
--app-image
directoryLocation of the predefined application image that is used to build an installable package
(absolute path or relative to the current directory)
See create-app-image mode options to create the application image.
--file-associations
pathPath 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.
--install-dir
pathAbsolute 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)
--license-file
pathPath to the license file
(absolute path or relative to the current directory)
--resource-dir
pathPath 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.
--runtime-image
pathPath of the predefined runtime image to install
(absolute path or relative to the current directory)
Option is required when creating a runtime installer.
Platform dependent options for creating the application package:
Windows platform options (available only when running on Windows):
--win-dir-chooser
Adds a dialog to enable the user to choose a directory in which the product is installed.
--win-help-url
urlURL 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-nameStart Menu group this application is placed in
--win-per-user-install
Request to perform an install 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
urlURL of available application update information
--win-upgrade-uuid
idUUID associated with upgrades for this package
Linux platform options (available only when running on Linux):
--linux-package-name
nameName for Linux package
Defaults to the application name.
--linux-deb-maintainer
email-addressMaintainer for .deb bundle
--linux-menu-group
menu-group-nameMenu group this application is placed in
--linux-package-deps
Required packages or capabilities for the application
--linux-rpm-license-type
typeType of the license ("License: value" of the RPM .spec)
--linux-app-release
releaseRelease value of the RPM <name>.spec file or Debian revision value of the DEB control file
--linux-app-category
category-valueGroup value of the RPM /
.spec file or Section value of DEB control file --linux-shortcut
Creates a shortcut for the application.
macOS platform options (available only when running on macOS):
- '--mac-dmg-content additional-content[,additional-content...]
Include all the referenced content in the dmg.
This option can be used more than once.
jpackage Examples
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>