Build instructions

magic-trace is written in OCaml. It uses opam as its package manager, and dune as its build system.

1. Install opam

bash -c "sh <(curl -fsSL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)"
opam init --bare

2. Select the 4.14.0 OCaml compiler

opam switch create magic-trace 4.14.0
eval $(opam env --switch=magic-trace)

3. Clone the magic-trace repo

git clone https://github.com/janestreet/magic-trace.git
cd magic-trace

4. Install dependencies

opam install ocamlformat.0.26.2
opam install ./magic-trace.opam --deps-only

5. Build, test, and autoformat it

dune build @default @runtest @fmt --auto-promote

6. Run it

_build/default/bin/magic_trace_bin.exe -help