substrate explain to generate a self-contained HTML file that maps your entire workflow. The output requires no assets, no build step, and no running Substrate installation — open it straight in a browser. Use it to show someone your workflow, check it into the repo, attach it to a PR that changes a gate, or hand it to a teammate who doesn’t run Substrate locally.
Usage
Options
string
Where to write the file. Defaults to
./substrate-explain.html.What the Map Shows
For each board, the file includes:- An inline-SVG flow diagram of the groups in position order, with guards drawn on the transitions they gate
- A table of the
field_schemawith conditions rendered readably - A table of policies with their conditions rendered readably
No Database Required
explain reads substrate-as-code only. It never opens data.sqlite — it works with no database at all, including in a fresh clone. It never contains task data.