Getting started

poststruct audits baked HTML: the built output your static site, your prerender, or your SPA shell actually ships. It is a zero-dependency CLI (Node 20 or newer) and it reads files on disk only.

Install

# run it straight from npm, no install
npx poststruct audit dist/

# or pin it as a devDependency for CI
npm install --save-dev poststruct

First audit

Point audit at any directory of baked HTML (default: dist):

npx poststruct audit dist/           # human output, one line per finding
npx poststruct audit dist/ --json    # {schema: 1, counts, findings}

A clean run prints one summary line. Findings print one per line, and the process exits exactly:

What the audit reads

The head module checks every page: title present and in band, description present and in band, canonical present and absolute, the OG and Twitter tag sets, og:image in a raster format (an SVG og:image FAILs: most social scrapers cannot render it), JSON-LD that parses with the LocalBusiness recommended fields, h1 sanity, and the 404 noindex contract. The site module checks the tree: a sitemap.xml with loc entries and lastmod, and a robots.txt that points at it.

The full list, per module and per status, lives in the check catalog.

CI

poststruct gates on its exit code, so the CI wiring is one step:

- run: npx poststruct audit dist/

The CI page carries the family-shaped battery, and the packs page shows how poststruct’s own audits are shaped once the pack loader realizes in your repo.