https://github.com/chirontt/jgit.pgm.native
compile command-line JGit PGM application to native executable using GraalVM native-image utility.
https://github.com/chirontt/jgit.pgm.native
graalvm-native-image jgit jgit-library jgit-pgm
Last synced: 9 days ago
JSON representation
compile command-line JGit PGM application to native executable using GraalVM native-image utility.
- Host: GitHub
- URL: https://github.com/chirontt/jgit.pgm.native
- Owner: chirontt
- License: epl-2.0
- Created: 2021-03-10T00:00:38.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-12-19T02:12:05.000Z (about 1 month ago)
- Last Synced: 2025-12-21T23:50:08.461Z (about 1 month ago)
- Topics: graalvm-native-image, jgit, jgit-library, jgit-pgm
- Language: Java
- Homepage:
- Size: 2.2 MB
- Stars: 2
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Native executable for command-line JGit program (PGM)
[](https://github.com/chirontt/jgit.pgm.native/actions/workflows/gradle-build.yml)
[](https://github.com/chirontt/jgit.pgm.native/actions/workflows/maven-build.yml)
[JGit PGM](https://github.com/eclipse-jgit/jgit/tree/master/org.eclipse.jgit.pgm), part of the Eclipse [JGit](https://github.com/eclipse-jgit/jgit) [project](https://projects.eclipse.org/projects/technology.jgit),
is the stand-alone command-line Java program which provides Git commands similar
to the native [git](https://git-scm.com) commands, to access Git repositories.
Usually distributed as a jar package, JGit [PGM](https://github.com/eclipse-jgit/jgit/tree/master/org.eclipse.jgit.pgm)
is also distributed as a stand-alone, self-contained (with all dependencies), executable shell archive,
from Maven Central, like
[this](https://repo1.maven.org/maven2/org/eclipse/jgit/org.eclipse.jgit.pgm/7.2.1.202505142326-r/org.eclipse.jgit.pgm-7.2.1.202505142326-r.sh)
of the 7.2.1 version. This shell archive is then normally renamed to `jgit` locally for ease of typing.
On Linux, the shell archive can be run directly.
On Windows, the shell archive can be run with the `java` command, like:
`java -jar org.eclipse.jgit.pgm-6.7.0.202309050840-r.sh --version`
This project aims to produce platform-specific, native executable `jgit` of the JGit PGM
using the [GraalVM native-image](https://www.graalvm.org/reference-manual/native-image) utility,
complementing the shell archive distribution.
Gradle and Maven build scripts are provided for building the project. The latest JGit version used here is [7.3.0](https://projects.eclipse.org/projects/technology.jgit/releases/7.3.0).
## Build pre-requisites
The [GraalVM native-image](https://www.graalvm.org/reference-manual/native-image) page
shows how to set up GraalVM and its native-image utility for common platforms.
[Gluon](https://gluonhq.com/) also provides some setup [details](https://docs.gluonhq.com/#_platforms)
for GraalVM native-image creation.
Actually, because this PGM application can produce a graphical window showing the commit logs,
via the command `jgit glog`, e.g.:
and thus for a *Swing-based application* like this PGM project, an implementation of GraalVM called
the [Liberica Native Image Kit](https://bell-sw.com/pages/downloads/native-image-kit/)
can produce a *working* native executable better than the stock
[GraalVM-CE](https://github.com/graalvm/graalvm-ce-builds) software could, for some reason.
This Liberica NIK software is used in the GitHub Actions
[build scripts](https://github.com/chirontt/jgit.pgm.native/tree/main/.github/workflows)
of this project to successfully build and generate the relevant *working* native images for Linux and Windows.
The GraalVM native-image utility will use the configuration files in
`src/graal-cfg//META-INF/native-image` folder to assist in the native image generation.
## Gradle build tasks
To run the JGit PGM in standard JVM with Gradle, execute the `run` task
with relevant parameters as needed:
gradlew run --args="--version"
gradlew run --args="ls-remote "
gradlew run --args="clone "
gradlew run --args="glog"
etc.
To produce a native executable, execute the `nativeCompile` task:
gradlew nativeCompile
The `nativeCompile` task would take a while to compile the application and link into an executable file.
The resulting `jgit` executable file is:
build/native/nativeCompile/jgit
(or if building on a Windows machine, the executable file is:
build\native\nativeCompile\jgit.exe
)
which can then be run directly (with relevant parameters):
./build/native/nativeCompile/jgit --version
./build/native/nativeCompile/jgit ls-remote
./build/native/nativeCompile/jgit clone
./build/native/nativeCompile/jgit glog
etc.
(or if building on a Windows machine:
build\native\nativeCompile\jgit.exe --version
build\native\nativeCompile\jgit.exe ls-remote
build\native\nativeCompile\jgit.exe clone
build\native\nativeCompile\jgit.exe glog
etc.
)
## Maven build tasks
To compile and run the JGit PGM in standard JVM with Maven, execute the
`compile` then `exec:exec` task with relevant parameters as needed:
mvnw compile
mvnw exec:exec -Djgit.args="--version"
mvnw exec:exec -Djgit.args="\"ls-remote \""
mvnw exec:exec -Djgit.args="\"clone \""
mvnw exec:exec -Djgit.args="glog"
etc.
To produce a native executable, execute the `package` task:
mvnw package
The `package` task would take a while to compile the application and link into an executable file.
The resulting `jgit` executable file is:
target/jgit
(or if building on a Windows machine, the executable file is:
target\jgit.exe
)
which can then be run directly (with relevant parameters):
./target/jgit --version
./target/jgit ls-remote
./target/jgit clone
./target/jgit glog
etc.
(or if building on a Windows machine:
target\jgit.exe --version
target\jgit.exe ls-remote
target\jgit.exe clone
target\jgit.exe glog
etc.
)