Skip to the content.

← Command reference · lean-pkg index · CLI overview

lean-pkg index check

static check, or re-derive entries from bytes at the pin; exit 0/1/2.

Usage

lean-pkg index check [--clone] [--repo DIR] [--index INDEX] [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  
--clone clone each entry’s repo at the pin into a temp dir
--repo DIR local clone for a single NAME (never modified) (old spelling –repo-dir, kept working)
--index INDEX index root (default: $LEAN_PKG_INDEX, else index/ beside the registry when present, else ./index)

Details

Form What it does Key flags
index check [NAME ...] index root: --index, else env LEAN_PKG_INDEX, else index/ beside the registry when present, else ./index; check, render and migrate exit 1 with no index at <path> when it is missing (render creates it only for an explicit --index or --out). Static checks, or re-derive each entry from bytes at the pin and recompute trust; Palomar and Reservoir verified when reachable, else skipped; the summary N entries checked: all pass\|FAILED comes before the per-entry lines and again last; exit 0, 1 or 2 [--clone] [--repo-dir PATH] [--index PATH]

Exit codes

Exit 1 is also a negative answer here: