Reference
Command line
The isoloom commands: validate, targets, resources and generate, with their options and exit codes.
isoloom <command> [DIR] [options]
DIR is the project folder, holding isoloom.yml (or isoloom.yaml). It defaults to the
current folder.
isoloom validate
Checks the spec and that every path it mentions exists.
| Option | Effect |
|---|---|
--skip-files | Don't check that files exist (useful before writing them). |
--json | { "ok": bool, "problems": [{ "at", "message" }] } |
Exit code 0 when valid, 1 when there are problems, 2 when the spec can't be read.
isoloom targets
Lists every target with ✓ or ✗ and the reason. --json prints the possible targets as an array.
isoloom resources
Adds up machines, CPUs, memory and disk, as VMs. --json for machine-readable output.
isoloom generate
Writes each target's files under .isoloom/, for every possible target that has a generator, or
one target with --target docker / --target vagrant. Targets it skips are listed with the
reason (not possible for this spec, a feature not supported yet, or no generator yet).
| Target | File | Run it with |
|---|---|---|
docker | .isoloom/docker/compose.yml | docker compose -f .isoloom/docker/compose.yml up -d --wait |
vagrant | .isoloom/vagrant/Vagrantfile | cd .isoloom/vagrant && vagrant up |
Every generated file starts with a "generated, don't edit" header. Commit them: the environment then runs with plain Docker or Vagrant, without Isoloom installed.
isoloom check
Regenerates in memory and compares with the files under .isoloom/. Exits 1 and names the
files that are missing or out of date. Run it in CI so the committed files never drift from the
spec.
isoloom coverage
Shows what each output (Docker Compose, Vagrant, Terraform, Ludus) does with every field of the
spec; --markdown prints the full table with the details. The same table is on the
coverage page.