Skip to content
CLI referencecheck

check

Prove the catalogue in the repository matches the sources it came from.

Usage

shell
npx mokly check

Options

Option Meaning
--config <path> Use an explicit mokly.config file
--debug-timings Report phase timings and catalogue counts on standard error

What it validates

Check compiles the catalogue and calculates the same bytes build would write, without writing them. It validates your entries, the links between them and the resources they reference.

With committed output it then compares those bytes with the files in the repository and reports generated files that are missing, stale or no longer part of the catalogue.

With derived output it instead requires that no generated file or cache path is tracked in Git. Your authored public CSS and HTML stay tracked as usual, and local generated files need not exist or match. The index check also recognises ownership headers on generated pages that were renamed or removed from the current catalogue, even when no local copy is left.

In continuous integration

check is the command to run in CI: it needs no browser, no server and no network, and it fails when the committed catalogue and its sources disagree. When it reports a stale file, run mokly build, read the diff, and run check again.