b6b0f56980
- Dockerfile changed to use install.sh script (Works on x64 and aarch64 architecture) - Dockerfile_x64 with old build script for tests - Script warp4j improved to support to run on aarch64 architecture Cleaning up repository Updating compatibility in README.md
126 lines
3.9 KiB
Markdown
126 lines
3.9 KiB
Markdown
# Warp4j
|
|
|
|
Turn JAR (java archive) into self-contained executable in a single command.
|
|
|
|
## Features
|
|
|
|
- downloads java runtimes automatically
|
|
- makes runtimes optimized for your application
|
|
- creates self-contained binaries for Linux, macOS and Windows using [warp-packer](https://github.com/kirbylink/warp)
|
|
- works on Linux, macOS and Windows (with Windows Subsystem for Linux)
|
|
- supports cross "compilation"
|
|
- does not require neither JDK nor JRE installed
|
|
|
|
## TL;DR
|
|
|
|
Just put both `warp4j` and `warp-packer` somewhere in your PATH and run `warp4j app.jar`.
|
|
|
|
## Install
|
|
|
|
Curl one-liner installs latest versions of both `warp4j` and `warp-packer`:
|
|
|
|
```
|
|
bash -c "$(curl -fsSL https://github.com/kirbylink/warp4j/raw/branch/master/install.sh)"
|
|
```
|
|
|
|
This script will show missing dependencies (if there are any), they must be installed with your package manager.
|
|
|
|
See more install methods [here](INSTALL.md).
|
|
|
|
## Usage
|
|
|
|
```
|
|
$ ls
|
|
my-app.jar
|
|
|
|
$ warp4j my-app.jar
|
|
...
|
|
...
|
|
...
|
|
|
|
$ ls -1
|
|
my-app.jar
|
|
warped
|
|
|
|
$ ls warped
|
|
my-app-linux-x64
|
|
my-app-linux-x64.tar.gz
|
|
my-app-macos-x64
|
|
my-app-macos-x64.tar.gz
|
|
my-app-windows-x64.exe
|
|
my-app-windows-x64.zip
|
|
```
|
|
|
|
See help:
|
|
|
|
```
|
|
$ wapr4j --help
|
|
|
|
|
|
Usage: warp4j [options] <app.jar>
|
|
|
|
Turn JAR (java archive) into self-contained executable
|
|
|
|
Options:
|
|
-j, --java-version <version>
|
|
override JDK/JRE version
|
|
examples: "17", "17.0", "17.0.2", "17.0.2+9"
|
|
(default: 17)
|
|
-cp, --class-path <classpath>
|
|
adds additional classpaths to the jdeps call
|
|
--auto-class-path extract and get class-path values from jar file
|
|
ignored when -cp, --class-path is set
|
|
--spring-boot extract and get class-path values from
|
|
Spring-Boot application jar file
|
|
ignored when -cp, --class-path is set
|
|
-o, --output <directory>
|
|
override output directory;
|
|
this is relative to current PWD
|
|
(default: ./warped)
|
|
-p, --prefix <prefix>
|
|
if set, warp-packer will use the prefix
|
|
as target folder in which the
|
|
application should be extracted
|
|
--list show available java releases;
|
|
takes into consideration other options:
|
|
"--java-version", "--no-optimize", "--jvm-impl";
|
|
the output may be used to specify concrete
|
|
"--java-version"
|
|
--no-optimize use JRE instead of optimized JDK;
|
|
by default jdeps and jlink are used to create
|
|
optimized JDK for the particular jar;
|
|
JRE is always used for java 8
|
|
--pull check if more recent JDK/JRE distro is available;
|
|
by default latest cached version that matches
|
|
"--java-version" is used
|
|
to get the classpath for jdeps call
|
|
--linux create binary for Linux
|
|
--macos create binary for macOS
|
|
--windows create binary for Windows
|
|
if no targets are specified then binaries for
|
|
all targets are created
|
|
--jvm-options <options>
|
|
passed to java like this:
|
|
"java <options> -jar <jar file>";
|
|
use quotes when passing multiple options
|
|
example: '-Xms512m -Xmx1024m'
|
|
-s, --silent using javaw instead of java for windows
|
|
-h, --help show this message
|
|
|
|
```
|
|
|
|
## Compatibility
|
|
|
|
Tested on the following operating systems:
|
|
|
|
- Debian 12.5
|
|
|
|
## Cache Location
|
|
|
|
Downloaded runtimes and prepared bundles are here:
|
|
|
|
- Linux: `$HOME/.local/share/warp4j`
|
|
- macOS: `$HOME/Library/Application Support/warp4j`
|
|
|
|
To override cache path, set `WARP4J_CACHE` environment variable.
|