Installation and Setup

This guide assumes that you are familiar with Java, and have a Java version of at least 11 installed on your computer already.

You can get the latest version of the software from the Releases page. There will be two downloads: one ending in gui.jar and one ending in cli.jar. It is your personal preference whether to use the GUI or the CLI.

Put the JAR file wherever you'd like, as long as you can invoke it from the command line. It might be most convenient just to put it in the root of your Java project.

Regardless of whether you downloaded the GUI or CLI, you can invoke it like so (replacing <path to jar> with the actual path to the JAR file):

java -jar <path to jar>

If you're using the GUI, its window should open. If you're using the CLI, it should print usage and version info.

(If you're using the GUI, you might be able to open it just by double-clicking the JAR, depending on your computer's settings.)

Now proceed to the Getting Started guide for either the GUI or the CLI.

Troubleshooting

If the application doesn't launch, your java command might refer to a version less than Java 11. Try replacing the java command with an explicit path to a Java 11 (or newer) executable. In full, the command should look like this:

<path to java.exe> -jar <path to jar>