Skip to main content

csd-intent

Cross-runtime audit tool for CSD intent specifications. Validates intent.yaml against CSD-INTENT-01 and confirms every claim is attested by at least one test marker across any test runner - pytest, vitest, Playwright, Jest, or anything that uses the standard intent() / @intent() marker shape.

This tool is standalone. It does not run inside your project's test suite; it is invoked separately (CLI, CI step, or pre-commit hook).

Why it exists

pytest-intent, vitest-intent, and playwright-intent provide the test-side marker helpers - they let a test declare which intent claim it attests. They deliberately know nothing about other runtimes, schema validation, or whether a claim is unattested.

csd-intent owns the cross-runtime auditing: it walks every test file in the project (Python via AST, TS/JS via regex), reads intent.yaml, and answers:

  1. Schema - does every claim match CSD-INTENT-01?
  2. Orphan - does every test marker reference a real claim?
  3. Coverage - does every claim have at least one attesting test, anywhere?

Install

# From PyPI:
pip install csd-intent

# Local dev against a csd-library checkout:
pip install -e path/to/csd-library/csd-intent

Use

# Audit the current directory (expects intent.yaml at the root):
csd-intent

# Audit a specific project:
csd-intent /path/to/project

# Audit but tolerate unattested claims (the "intent before test" workflow):
csd-intent --fail-on schema

# Constrain the scan to specific directories:
csd-intent --tests-dir backend/tests --tests-dir frontend/src --tests-dir e2e

# Quiet summary only:
csd-intent --quiet

# The same audit as one JSON object on stdout, for a script or a dashboard:
csd-intent --json

Exit code is 0 on a clean audit, 1 when any violation falls into the configured --fail-on set (any by default).

Output

intent.yaml (/path/to/project/intent.yaml): 24 claims, 2 violation(s).

UNATTESTED (2):
  [unattested] INT-SB-018: no @intent / intent() marker references this claim
  [unattested] INT-SB-029: no @intent / intent() marker references this claim

JSON output

--json prints the same audit as one JSON object on stdout and nothing else. The exit code still follows --fail-on, so one run both records the summary and gates on it.

{
  "generated_at": "2026-09-22T09:41:07Z",
  "claims": 24,
  "attested": 20,
  "unattested": 2,
  "draft": 1,
  "active": 22,
  "deprecated": 1,
  "violations": 2,
  "requirements_traced": 17,
  "clean": false,
  "projects": [
    {
      "intent_path": "/path/to/project/intent.yaml",
      "claims": 24,
      "attested": 20,
      "unattested": 2,
      "draft": 1,
      "active": 22,
      "deprecated": 1,
      "violations": 2,
      "requirements_traced": 17,
      "clean": false,
      "claims_by_id": {
        "INT-SB-001": {
          "status": "active",
          "attested": true,
          "scope": "unit",
          "derived_from": ["REQ-003"]
        }
      }
    }
  ]
}
Key Meaning
claims claims declared in intent.yaml
attested claims at least one marker references: the report's "N attested"
unattested claims the report lists under UNATTESTED: active, runner-scoped, and unmarked
draft, active, deprecated claims by status
violations violations of every kind: the report's "N violation(s)"
requirements_traced distinct ids across every claim's derived_from annotation
clean true when there is no violation of any kind
generated_at when the audit ran, ISO-8601 UTC
projects one entry per audited project, root first, with its intent_path, its own counts, and its claims_by_id
claims_by_id in each projects[] entry: that project's claims by id, each with status, attested, scope, and derived_from

Draft, deprecated, and unmarked llm claims are neither attested nor unattested, so those two counts do not sum to claims. A tree of nested projects sums its counts into the top-level keys and keeps requirements_traced distinct across projects; a claim id is scoped to the project that declares it, so an id two projects both declare is reported under each.

What it scans

  • Python: any file matching test_*.py or *_test.py, walked via AST for @intent("INT-...") decorators on functions starting with test_.
  • JS/TS: any file matching *.test.{ts,tsx,js,jsx,mts,cts} or *.spec.{ts,...}, scanned by regex for intent('INT-...', 'name', fn) calls (single-ID and array-of-IDs forms both supported).
  • Excluded directories: node_modules, .venv, venv, dist, build, .git, __pycache__, .pytest_cache, .mypy_cache, .ruff_cache, .tox.

CSD-INTENT-01 conformance

The schema check validates each claim against the canonical fields per CSD-INTENT-01 §4.1:

INT-NNN:
  version: 1.0.0
  status: active                # draft | active | deprecated
  statement: "..."              # >= 10 chars, RFC 2119 language
  rationale: "..."              # optional but recommended
  test:
    scope: integration          # unit | integration | e2e | llm
    component: SwitchFlow
    type: behavior              # invariant | behavior | contract
  criticality: critical         # critical | high | medium | low

For projects still on the legacy flat-scope: shape, the tool accepts it (with no warning) - that's a migration concession, not a recommendation.

Duplicate keys are refused

intent.yaml is parsed with a loader that raises on a repeated key rather than resolving it last-wins. A claim id reused by accident would otherwise delete the earlier claim before any check could see it - and every marker written for that claim would silently start attesting the survivor, with the audit still printing CLEAN. The duplicate is reported as a schema violation naming both lines:

SCHEMA (1):
  [schema] intent.yaml: duplicate key `INT-GATE-006` (first declared on line 42,
  declared again on line 187); YAML would silently keep only the last one

Merge keys still work: <<: *base plus an explicit override is not a duplicate.

License

MIT.

Metadata

Release files for csd-intent 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for csd-intent 0.6.0
File Size Uploaded Provenance Actions
csd_intent-0.6.0.tar.gz 28.1 kB With provenance Details for csd_intent-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for csd-intent 0.6.0
File Interpreter ABI Platform Actions
csd_intent-0.6.0-py3-none-any.whl Python 3 none any Details for csd_intent-0.6.0-py3-none-any.whl

Total release size: 47.6 kB

Release files / csd_intent-0.6.0.tar.gz

Download URL csd_intent-0.6.0.tar.gz
Size 28.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f04a6f494266548b5ea4f8e798e857f6f91f50212328fb0aa36a51dfd9bd624b
BLAKE2b-256 checksum
How to use checksums
7e4b24bec4b84c0e1cb55682d79862ef56d0a651960bae0079bf4290d3e39c19
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log

Release files / csd_intent-0.6.0-py3-none-any.whl

Download URL csd_intent-0.6.0-py3-none-any.whl
Size 19.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a838274330d6c57429d3506ec23111eae3eba9c2b92a02cadedefd4274d19d9d
BLAKE2b-256 checksum
How to use checksums
b6b37c45b7f7067081e60229cd4a90ab76b1a6ed4d8d7fcd0c7655e2ed41f1a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log

Security for csd-intent 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for csd_intent-0.6.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page