Skip to main content

Governed frontmatter, freshness tethers, and validate-only runtime gates for agent-facing Markdown

Reason this release was yanked:

Security: superseded by 0.9.4

Project description

Frontmattering

Frontmattering makes Markdown safer for agents.

It adds governed frontmatter, task routing, body/frontmatter freshness tethers, and a vendorable validate-only runtime gate so an agent can consume a compact brief without silently relying on stale documentation.

Install

python -m pip install frontmattering
frontmattering --version
frontmattering doctor

First-hour path

frontmattering init . scaffolds a starter router under docs/, and frontmattering new creates governed documents. This block runs verbatim in an empty directory (it is executed as a release gate in CI):

frontmattering init . --set-id MYDOCS --title "My docs"
frontmattering new docs/10_GUIDE.md --profile guide --title "My guide"
frontmattering tether update --add .
frontmattering validate .
frontmattering brief .

Already have Markdown under docs/? Add governance to a file you already have with promote (one file per call):

frontmattering promote docs/YOUR_GUIDE.md --profile guide --in-place

Promoting a file outside the selected corpus fails before the file is touched (FRONTMATTERING-AUTHORING-TARGET-OUTSIDE-CORPUS).

For strict freshness enforcement, set validation_profile: trust in .frontmattering/project.yaml, then re-run frontmattering validate . and frontmattering brief ..

Runtime gate

frontmattering runtime pack --out frontmattering-runtime.pyz
python frontmattering-runtime.pyz validate docs --format json

The runtime artifact is validate-only. It does not expose init, promote, new, index, tether update, or authoring surfaces.

Prompt pack

The validator proves your frontmatter is valid, current, scoped, and tethered. It does not prove the frontmatter is good — a GO document can still carry a copied summary or a generic deepest intention. The governed prompt pack closes that gap: it makes authoring excellent, body-grounded frontmatter repeatable.

frontmattering prompt list
frontmattering prompt inspect author-category-frontmatter
frontmattering prompt render \
  --task author-category-frontmatter \
  --category self_protection_layer \
  --support-profile frontmattering_only \
  --corpus-root docs \
  --output rendered_prompt.md --receipt-out render_receipt.yaml

prompt render is deterministic: it composes the prompt from a packaged task template, a structured category profile, a support profile, and shared fragments, and binds the rendered bytes to every input's digest — including the authorizing manifest, renderer source, distribution, and serializer identity. The core CLI never executes an LLM — a rendered prompt proves only that the bytes were deterministically composed, not that a model ran or that an authoring result is semantically correct.

Run frontmattering prompt verify (also a doctor step) to confirm the packaged pack renders cleanly, reproduces its worked example, and conforms to its own shipped JSON schemas. Run frontmattering prompt verify-rendered --prompt rendered_prompt.md --receipt render_receipt.yaml to check a rendered prompt against its receipt: it recomputes every bound digest and reports tampering (FRONTMATTERING-PROMPT-TAMPERED) or resource drift.

License

Frontmattering is source-available. It is free for individual personal use within the scope of LICENSE.md. Professional, organizational, employer, client, CI/CD, hosted, managed-service, platform, consulting, or revenue-connected use is permitted for a 30-day evaluation period under LICENSE.md; continued use after the evaluation requires a paid commercial license.

Frontmattering is not open-source software under the Open Source Definition because professional and organizational use is restricted without a commercial license.

Runtime dependency status is recorded in THIRD_PARTY_NOTICES.md; project notices are recorded in NOTICE.

Claim boundary

A FRESH brief means the current body bytes and canonical trust-bearing frontmatter fields match their mechanical tether. It does not prove semantic summary correctness, human approval, external adoption, or production suitability.

A STALE or UNTETHERED summary must not be relied on without reading the body.

Publication status

This v0.5.1 package makes the prompt pack govern its own evidence: render receipts conform to their shipped JSON schema, prompt verify enforces every packaged schema, prompt verify-rendered detects tampering, and the receipt binds the full authorizing pack identity. It also strengthens the SQLite index-ownership guard and hardens the release pipeline (two-stage OIDC publish of the exact tested artifact, SHA-pinned actions). It carries forward every destructive-output and trust-boundary guard from the 0.4.x and 0.5.0 lines and makes no validator trust-semantics, frontmatter-schema, or canonical-model (v0.1.5) changes. Operation-wide mutation transactions, a hermetic runtime, and the exception-hierarchy unification remain deliberately deferred to a later designed pass. Custom license text should still receive legal review before paid commercial sales.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frontmattering-0.5.1.tar.gz (505.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

frontmattering-0.5.1-py3-none-any.whl (496.9 kB view details)

Uploaded Python 3

File details

Details for the file frontmattering-0.5.1.tar.gz.

File metadata

  • Download URL: frontmattering-0.5.1.tar.gz
  • Upload date:
  • Size: 505.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for frontmattering-0.5.1.tar.gz
Algorithm Hash digest
SHA256 3199c4861293c21e38cc104fa9dc902043ad6edebb24a505baf1c6aedf53f6dd
MD5 f843ab96469b3d00146fa309a98ba97d
BLAKE2b-256 b5bc6fadc29283e0ea292da99e8ef855d86da10993ece91afa90c3854808d2ed

See more details on using hashes here.

Provenance

The following attestation bundles were made for frontmattering-0.5.1.tar.gz:

Publisher: publish.yml on frontmattering/frontmattering

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file frontmattering-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: frontmattering-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 496.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for frontmattering-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 38ccc83245520a2a6a2413f0b8317d5fe5b6ed28d45ec14ae9186eae480e9157
MD5 8a3b48668fc79df026ad085a6e7ea847
BLAKE2b-256 b1b064c224d33bfb99fd139173df0f2ab6a39a272c84766375c5f9c965192cfe

See more details on using hashes here.

Provenance

The following attestation bundles were made for frontmattering-0.5.1-py3-none-any.whl:

Publisher: publish.yml on frontmattering/frontmattering

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page