← Command reference · lean-pkg index · CLI overview

lean-pkg index render

write the Markdown table (default <index>/README.md).

Usage

lean-pkg index render [--out OUT] [--check] [--index INDEX] [common flags]

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

Arguments and flags

Argument or flag Description
--out OUT  
--check exit 1 when the file is stale; write nothing
--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 render write the Markdown table (default index/README.md), plus a claims list when index-entry/2 entries exist [--out PATH] [--check] [--index PATH]

Exit codes

Exit 1 is also a negative answer here: