Skip to content

Getting started

There are several ways to get up and running with binjr:

Download an application bundle

The simplest way to start using binjr is to download an application bundle from the download 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 than 60 MB in size and there is one for each of the supported platform: Linux, macOS and Windows.

binjr for Linux is packaged as a tar.gz archive: unpack it and run binjr to start.

binjr for macOS is packaged as a dmg image: mount the image and click on binjr.

Note

binjr might not be recognized by Apple, so you may get a warning when trying to run the first time. To override it, locate binjr in the Finder on your Mac, control-click the app icon, then choose Open from the shortcut menu and click Open (see more).

If you want to ensure that your download has not been tempered with, you can verify its openGPG signature.

binjr for Windows is packaged as an msi installer: run the installer and launch binjr from the start menu.

Note

binjr’s installer might not be recognized by Microsoft Defender SmartScreen, so you might need to suppress a warning to install it on your system. To do so, click “more info” then “run anyway” (see more).

If you want to ensure that your download has not been tempered with, you can verify its openGPG signature.

Build from source

You can also build or run the application from the source code.

Prerequisites:

(Optional):

  • (macOS): Xcode command line tools and a version of OpenJDK including jpackage (14 or later) are required to build the DMG image.
  • (Windows): WiX 3.0 or later is required to build the MSI installer.

Build

  1. Clone the repo from Github:

    git clone https://github.com/binjr/binjr/
    

  2. Use the included gradle wrapper to:

    • Build all the modules

      sh gradlew build
      
      gradlew.bat build
      
    • Build and start the application

      sh gradlew run
      
      gradlew.bat run
      
    • Build an application bundle for the platform on which you run the build

      sh gradlew clean packageDistribution  
      
      gradlew.bat clean packageDistribution  
      

      Warning

      Please note that it is mandatory to run the clean task in between two executions of packageDistribution in the same environment.

Run from the command line

You can also start binjr simply by running a single command line. Running 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.

Note

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

mvn exec:java -f <(curl https://binjr.eu/run-binjr.pom)
curl https://binjr.eu/run-binjr.pom > %temp%\run-binjr.pom & mvn exec:java -f %temp%\run-binjr.pom

You can also use the binjr.versionproperty to start a specific version of binr:

mvn exec:java -f <(curl https://binjr.eu/run-binjr.pom) -Dbinjr.version=2.14.0
curl https://binjr.eu/run-binjr.pom > %temp%\run-binjr.pom & mvn exec:java -f %temp%\run-binjr.pom  -Dbinjr.version=2.14.0

Tip

Downloaded components are cached locally by Maven, so it doesn’t need to download them again every time you run the application.

Trying it out

If you’d like to experience binjr’s visualization capabilities but do not have a compatible data source handy, you can use the demonstration data adapter.

It is a plugin which embeds a small, stand-alone data source that you can readily browse using binjr.

  1. Make sure binjr is installed on your system and make a note of the folder it is installed in.
  2. Download the binjr-adapter-demo-1.x.x.zip archive from https://github.com/binjr/binjr-adapter-demo/releases/latest
  3. Copy the binjr-adapter-demo-1.x.x.jar file contained in the zip file into the plugins folder of your binjr installation.
  4. Start binjr (or restart it if it was runnning when you copied the plugin) and open the demo.bjr workspace contained in the zip (from the command menu, select Workspaces > Open..., or press Ctrl+O)