Skip to content

Getting started

Installation

Install the isoloom command-line tool, or embed isoloom-core in your own Rust program.

Isoloom is written in Rust and ships in two parts:

  • isoloom, the command-line tool, for authors and CI.
  • isoloom-core, the library behind it, for programs that embed the format directly (for example a launcher that needs to validate a spec before running it).

From source

Isoloom needs Rust 1.85 or newer.

git clone https://github.com/isoloom/isoloom.git
cd isoloom
cargo install --path crates/isoloom

Check it works:

isoloom --version

Coming soon: signed release binaries for macOS, Linux and Windows, a container image for CI, and a reusable GitHub Action. Until then, install from source.

As a library

Add the core crate to your Cargo.toml (it isn't on crates.io yet, so use the Git source):

[dependencies]
isoloom-core = { git = "https://github.com/isoloom/isoloom" }

Then load and check a spec:

let spec = isoloom_core::load(std::path::Path::new("."))?;
let problems = isoloom_core::validate(&spec);
let targets = isoloom_core::effective(&spec);