CLI reference

poststruct ships one binary with two verbs. The documented verb-first forms are also mathematically safe to skip: only a known verb is ever stripped from argv, so a typo’d first word can never silently become a verb or a fantasy directory.

`poststruct audit [dir] [--json] [--module x]`

Walks dir (default: dist) and audits every baked HTML page it finds.

Flag	Value
`--json`	prints `{schema: 1, counts: {fail, warn}, findings}` instead of prose
`--module head\\|site`	audits one module only, position-independent

`poststruct lint-packs [--deep] [--json] [--against <lib>] [dir]`

The pack lint lane as a discoverable verb: it runs packstruct over the repo’s own install, passes its exit codes through unchanged, and refuses loudly with exit 2 when packstruct is not installed. --deep is the packstruct deep lint; --json forwards its shape. dir is the packs root (default: packs/).

Exit contract

Exit	Meaning
`0`	clean, or warnings only
`1`	at least one FAIL finding (or the lint lane’s own pass-through)
`2`	usage or environment error: no directory to walk, a bad flag value, or packstruct missing

Findings schema

--json output is a stable schema (schema: 1). Fields are additive first: new finding ids may appear, existing ids never change meaning.

{
  "schema": 1,
  "counts": { "fail": 0, "warn": 2 },
  "findings": [
    { "page": "index.html", "id": "title-absent", "level": "warn", "message": "no <title> in head" }
  ]
}

Programmatic use

The same engine is exportable: runAudit(dir, { module }) from src/index.mjs (import { runAudit } from 'poststruct' resolves it) returns the {hasFails, counts, findings, pagesChecked, sitemapLocs} the CLI prints.

More in these docs: home · getting started · check catalog · packs