← Command reference · lean-pkg comparator · CLI overview

lean-pkg comparator check

validate a comparator receipt against the package; read-only, records nothing, works at any status (comparator NAME --receipt R --check is the same).

Also spelled: lean-pkg comparator NAME --receipt R --check, lean-pkg comparator attach NAME --receipt R --check (all aliases).

Usage

lean-pkg comparator check [--receipt RECEIPT] [--refuse-private] [--refuse-dirty]
                          [--repo DIR] [common flags] NAME

[common flags]: --json, --commit, --push, --no-commit, also accepted before the command name; see the CLI overview.

Arguments and flags

Argument or flag	Description
NAME
--receipt RECEIPT	path to comparator receipt JSON (required)
--refuse-private	refuse (exit 1) when the receipt holds private strings; default is a WARN line
--refuse-dirty	refuse when tracked files are modified in the checkout; default is a WARN line
--repo DIR	validate against the checkout DIR instead of the registered local_path, for this call (never saved; JSON repo_override). DIR must be a git work tree, and when it has remotes one must be the package’s repo

Details

Form	What it does	Key flags
comparator check NAME --receipt PATH	validate a comparator receipt against the package and record nothing; works at any status; the checks, private-string scan and --repo DIR rules of comparator attach (above it in the tree: comparator attach); the pre-1.0 spelling comparator NAME --receipt PATH --check keeps working	--receipt PATH [--repo DIR] [--refuse-private] [--refuse-dirty] [--json]

Examples

Validate a comparator receipt against the package without recording it; works at any status.

lean-pkg comparator check my-proof --receipt .lean-receipts/cb3d68a21454-comparator.json