Skip to content
markdown-contract

Validate from the terminal

Each example builds on the one before it — read the group in order, or jump to the one you need. Every shipped artifact is regression-checked against the real CLI and library output.

  1. Check a folder of docs — Point validate at a folder and get a verdict: a run summary, findings if any, and a CI-ready exit code.
  2. Read a finding, fix the doc — A document that breaks its contract produces a finding pinned to a source line — open the file at that line and fix it.
  3. Findings as JSON or SARIF — The same run renders for machines: --format json emits the raw findings array, --format sarif feeds code-scanning uploads.
  4. Bind a contract directly, scope the run — No config file needed: --contract binds one contract to a folder, and --include / --exclude narrow any run without touching config.
  5. Scaffold the config with init — init reads the markdown you already have, infers the tightest config that accepts it, and doubles as a CI drift guard with --check.

Or browse all examples, or open the CLI reference for the underlying spec.