Skip to content

Command-Line Interface

Use betacal-printlint --help for the complete option list.

Command Purpose
check PATH Detect JSON, SVG, or PDF by extension and validate it.
calendar Render a Gregorian month grid as JSON.
svg PATH Validate an SVG document and optional paper size.
pdf PATH Validate PDF page boxes, orientation, and page count.
manifest PATH Validate a JSON calendar manifest.
blank PATH Validate a date-free blank-grid JSON file.
fixture PATH Validate a committed reference fixture.
explain TOPIC Explain a validation rule or limitation.
version Print the installed package version.

Validation commands accept --format text, --format json, or --format sarif. JSON output includes valid, errors, warnings, checks, and details. Error findings return exit code 1. Warnings alone return 0.

Month generation example:

betacal-printlint calendar --year 2027 --month 1 --week-start monday --grid-mode fixed-six-weeks --hide-adjacent

File validation example:

betacal-printlint check export.svg --paper a4 --orientation portrait --format sarif