Skip to content

Getting started

Frederic Thevenet edited this page Oct 24, 2019 · 15 revisions

Download an application bundle

The simplest way to start using binjr is to download an application bundle from the release page.

These bundles contain all the dependencies required to run the app, including a copy of the Java runtime specially crafted to only include the required components and save disk space.
They are less about 50 MB in size and there is one for each of the supported platform: Windows, Linux and macOS.

Simply download the one for your system, unpack it and run binjr to start!

Launch the latest version via Apache Maven

Alternatively, if your environment is properly set up to run Java 11 and Apache Maven, you can start binjr simply by running the following command line:

On Linux or macOS:

  • To start the latest version:
    mvn exec:java -f <(curl
  • To start a specific version:
    mvn exec:java -f <(curl -Dbinjr.version=2.3.0

On Windows:

  • To start the latest version:
    curl > %temp%\run-binjr.pom & mvn exec:java -f %temp%\run-binjr.pom  
  • To start a specific version:
    curl > %temp%\run-binjr.pom & mvn exec:java -f %temp%\run-binjr.pom -Dbinjr.version=2.3.0

Runnning binjr that way means that you don't need to worry about keeping your copy up to date: it will always start the latest version that was published over on Maven Central (unless you explicitly set the desired version, see above).
Downloaded components are cached locally by Maven, so it doesn't need to download them again every time you run the application.

NB: In order to run binjr that way, you not only need to have Apache Maven installed on your machine but also need your JAVA_HOME environment variable to point at a copy of a Java runtime version 11 or later.

Build from source

You can also build or run the application from the source code using the included Gradle wrapper.
Simply clone the repo from Github and run:

  • ./gradlew build to build the JAR for the all the modules.
  • ./gradlew run to build and start the application straight away.
  • ./gradlew clean packageDistribution to build an application bundle for the platform on which you ran the build.
You can’t perform that action at this time.