Skip to content
markdown-contract

Check a folder of docs

validate-01 · CLI transcript

Point validate at a folder and get a verdict: a run summary, findings if any, and a CI-ready exit code.

Builds on: nothing — start here in Validate from the terminal.

The artifact

Section titled “The artifact”

A terminal session: the command as you’d run it, followed by the output it prints; trailing comments note the exit status.

Terminal window
# a folder of decision records; markdown-contract.yaml is auto-discovered from the cwd
markdown-contract validate ./decisions
Scanned 4 files; 4 matched across 1 contract, 0 unmatched
  decision: 4


No findings.
# exit status: 0 (clean)

What it exercises

Section titled “What it exercises”
  • validate subcommand
  • config auto-discovery (markdown-contract.yaml)
  • human run summary
  • exit code 0 (clean)

Continue

Section titled “Continue”