Skip to main content

CLI reference

Install the package from the repository root:

python3 -m pip install -e .

The nomenclator-delta console script and python3 -m nomenclator_delta expose the same commands.

collect

Download and content-address the current official export.

nomenclator-delta collect \
--snapshot 2026-09 \
--source-root sources
OptionRequiredDefaultMeaning
--snapshot YYYY-MMyesOperator-verified nominal release month.
--source-root PATHnosourcesRoot for artifacts and metadata sidecars.
--url URLnoofficial full CSV endpointOverride the collection endpoint.

The command prints the source metadata as JSON. It writes the downloaded file below artifacts/<snapshot>/ and the accompanying metadata below metadata/<snapshot>/. Both filenames contain the response's SHA-256 checksum.

Collection does not build or publish data. Before continuing, verify the filename, content type, checksum, size, and release month.

build

Compare one new source file with the latest validated snapshot and append the result.

nomenclator-delta build \
--from 2026-08 \
--to 2026-09 \
--to-source sources/artifacts/2026-09/<sha256>.csv \
--to-metadata sources/metadata/2026-09/<sha256>.json \
--output data
OptionRequiredDefaultMeaning
--from YYYY-MMyesEarlier snapshot.
--to YYYY-MMyesLater snapshot.
--from-source PATHfirst build onlyEarlier official artifact; omitted when appending.
--to-source PATHyesLater official artifact.
--from-metadata PATHnogenerated from artifactEarlier provenance sidecar.
--to-metadata PATHnogenerated from artifactLater provenance sidecar.
--output PATHnodataGenerated static data root.
--minimum-records Nno15000Sanity threshold per source snapshot.

In an empty output directory, build creates the first comparison and needs both raw source files. In an existing dataset, the new month must follow the latest month. Omit --from-source: the latest validated normalized snapshot is used as the earlier input. Existing snapshots, changes, and histories are kept, and only the new raw file is parsed.

validate

Check a generated dataset without reading raw source artifacts.

nomenclator-delta validate data

The path defaults to data. Every validation error is written to standard error and the process exits non-zero. Success prints Validated <path>.

dist

Create a deployable application directory.

nomenclator-delta dist \
--site site \
--data data \
--output dist
OptionDefaultMeaning
--site PATHsiteStatic application source.
--data PATHdataValidated generated JSON.
--output PATHdistDestination to replace with the packaged app.

The command copies the app and data. It does not parse or validate them. For safety, the output path cannot be / or the current working directory.