← Docs

CLI reference

In beta. The CLI ships alongside the public-API beta and is distributed to beta participants — it is not yet on the public npm registry. Request access.

Install the CLI and run your first check.

preflight login                  # paste your pfk_ key
preflight check statement.pdf    # human-readable result
preflight check statement.pdf --format sarif > results.sarif
preflight batch ./mailing/*.pdf  # a regression-diff batch
preflight ci dist/**/*.pdf       # CI mode (calibrated exit codes)

Output formats

• human (default) · json · junit (any CI test reporter) · sarif (SARIF 2.1.0 → GitHub Code Scanning) · markdown (PR comments).

Exit codes

• 0 — pass · 1 — findings at/above the configured severity · 2 — error.
• Configure via ~/.preflight/config.json or PREFLIGHT_API_KEY; the severity gate via --fail-on-severity (default critical).

CI integration →