Logo
Installation

Building from Source

We utilise Nix for our development and build process. This lets us have a unified, deterministic environment across multiple platforms.

You only need the Nix build tooling, you do not need to be using NixOS

Building the Engine

Our nix.flake exports the fractal-engine package as the default derivative, so you can build with:

nix build .# -L --print-out-paths

This will log the absolute path to the folder containing the built output binary for fractal-engine.

Building the CLI tool

This tool should only be used for exploration, not for production usage.

Similar to the engine itself, run:

nix build .#cli -L --print-out-paths

Once the CLI tool has been built, see CLI Tool for usage.