Get Started

This page takes you from scratch to a running Onyx example.

Java 8

The very first thing we need to do is check that Java is installed on your machine. Namely, Onyx requires that you're at least running Java version 8. Onyx depends on a 3rd party library called Aeron, which itself requires Java 8. Check what you're running with:

$ java -version
java version "1.8.0_40"
Java(TM) SE Runtime Environment (build 1.8.0_40-b25)
Java HotSpot(TM) 64-Bit Server VM (build 25.40-b25, mixed mode)


The next thing that you'll need is an installation of Clojure's primary build tool - Leiningen. There are great instructions on how to install it on Lein's website. You can check if you have it by running:

$ lein --version
Leiningen 2.5.2 on Java 1.8.0_40 Java HotSpot(TM) 64-Bit Server VM


Now that we've ensured that your environment is running properly, let's execute some Onyx code. The best place to start with onyx is called onyx-starter. It's a single, 100% stand-alone repository that's meant to give you playground to example some of the basic features. Clone it and run it with the following:

$ git clone
$ cd onyx-starter
$ lein test

next steps

If you made it this far, you probably have a lot of questions. That's okay - a distributed computation platform is a large, complex piece of software. The next place to turn to are the learn and documentation links on this website. You can also drop by Gitter to ask questions.