statecraft-ui

The npm package for the statecraft CLI. Statecraft checks public websites or renders configured UI product states with Playwright, captures screenshots and diagnostics, and writes an offline coverage report.

npm install --save-dev statecraft-ui [email protected]
npx playwright install chromium
npx statecraft check https://example.com
npx statecraft check https://example.com --write-config
npx statecraft scan

check <url> needs no Statecraft config. It discovers at most five same-origin HTML pages by default, checks each at mobile/desktop × light/dark, and writes screenshots, schema-v1 JSON, and the kinetic offline report beneath .statecraft/. Use --max-pages <1-20> to change the bounded discovery budget or --headed to watch Chromium. Add --write-config to save an overwrite-safe statecraft.config.mts and statecraft/scenarios/public/default.mts; the untouched result runs through npx statecraft scan. Run it only against websites you own or are authorized to test.

init generates statecraft.config.mts and statecraft/scenarios/home/success.mts, so the starter works without changing npm's default package type.

The package also exports defineConfig, checkPublicSite, config discovery/loading, initialization, scan orchestration, and report-opening APIs for TypeScript consumers. Generated public-site scenarios import the narrow statecraft-ui/public-site-scenario helper so they retain the same assertions as Quick Check without copying implementation code.

See the public website Quick Check guide for the complete first-run and promotion journey. The Statecraft repository contains configuration, scenario, CI, privacy, release-proof, and contribution guidance.