# reqmd

> Lightweight CLI for requirements-as-Markdown with trace checks. Git-native, text-first, no database. Validates 249 requirements in 16 ms; scales to 720k in 7 seconds.
> Lightweight CLI for requirements-as-Markdown with trace checks. Git-native, text-first, no database. Validates 249 requirements in 16 ms; scales to 720k in 7 seconds.
> Full content available at: https://reqmd.xyz/llms-full.txt

## Optional

- [Source on GitHub](https://github.com/dVoo/reqmd): GPL-3.0-licensed Go CLI, single binary, no runtime dependencies.

## Docs
- [Step 0 — Installation](https://reqmd.xyz/quickstart/00-installation/): Install reqmd in 30 seconds with go install, build from source, or download a prebuilt binary. Then verify the install against the bundled 249-requirement spec.
- [Step 1 — Get started](https://reqmd.xyz/quickstart/01-get-started/): Scaffold a new requirements project and run your first validation.
- [Step 1a — CI integration](https://reqmd.xyz/quickstart/01a-ci-integration/): Run reqmd in CI for validation gates and structured reports.
- [Step 2 — Trace your spec](https://reqmd.xyz/quickstart/02-trace-your-spec/): Build a multi-level V-model spec tree with trace links between levels.
- [Use cases](https://reqmd.xyz/use-cases/): Where reqmd fits — from writing your first requirement to CI-gated traceability and live review.
- [Cheat sheet](https://reqmd.xyz/cheat-sheet/): Full reqmd command reference with example outputs and schema.yaml options — every command, every flag, every x-reqmd option.
- [Step 2a — Status & disposition](https://reqmd.xyz/quickstart/02a-status-disposition/): The status lifecycle and the disposition workflow for deferred and rejected requirements.
- [Benchmarks](https://reqmd.xyz/benchmarks/): How fast is reqmd? Real numbers from a real run — from 249 requirements in 16 ms to 720,000 requirements in 7 seconds.
- [Step 2b — Version pins](https://reqmd.xyz/quickstart/02b-version-pins/): Pin trace references to a specific upstream version and detect when the upstream changes.
- [FAQ](https://reqmd.xyz/faq/): Frequently asked questions about reqmd — what it's for, how it works, and how it fits into your workflow.
- [Step 2c — Repin](https://reqmd.xyz/quickstart/02c-repin/): Bulk-update version-pin (~N) trace references to match the upstream's current version with reqmd repin --yes.
- [Step 3 — Export](https://reqmd.xyz/quickstart/03-export/): Export the spec tree to CSV, HTML, and graph formats.
- [Step 3a — Live preview](https://reqmd.xyz/quickstart/03a-live-preview/): Serve a live-reloading HTML preview while you edit your spec tree.
- [Step 3b — Baseline diff](https://reqmd.xyz/quickstart/03b-baseline-diff/): Compare requirement baselines between two git tags — no checkout needed.
- [Step 4 — Custom templates](https://reqmd.xyz/quickstart/04-custom-templates/): Define your own requirement schema with a custom reqmd init preset.
- [Step 5 — Verification results (CTRF)](https://reqmd.xyz/quickstart/05-verification-results-ctrf/): Load automated test results in CTRF format and run outcome-gated checks against your spec tree.
- [Step 6 — Review documentation](https://reqmd.xyz/quickstart/06-review-documentation/): Load manual verification results (review, inspection, analysis, demonstration) recorded as markdown with a user-supplied schema.

## Use cases

- [Use cases](https://reqmd.xyz/use-cases/): What reqmd is designed for, what it does well, and what is out of scope.

## Quickstart

- [Quickstart](https://reqmd.xyz/quickstart/): A seven-step tour from install to manual review results.
- [Step 0 — Installation](https://reqmd.xyz/quickstart/00-installation/)
- [Step 1 — Get started](https://reqmd.xyz/quickstart/01-get-started/)
- [Step 1a — CI integration](https://reqmd.xyz/quickstart/01a-ci-integration/)
- [Step 2 — Trace your spec](https://reqmd.xyz/quickstart/02-trace-your-spec/)
- [Step 2a — Status & disposition](https://reqmd.xyz/quickstart/02a-status-disposition/)
- [Step 2b — Version pins](https://reqmd.xyz/quickstart/02b-version-pins/)
- [Step 2c — Repin](https://reqmd.xyz/quickstart/02c-repin/)
- [Step 3 — Export](https://reqmd.xyz/quickstart/03-export/)
- [Step 3a — Live preview](https://reqmd.xyz/quickstart/03a-live-preview/)
- [Step 3b — Baseline diff](https://reqmd.xyz/quickstart/03b-baseline-diff/)
- [Step 4 — Custom templates](https://reqmd.xyz/quickstart/04-custom-templates/)
- [Step 5 — Verification results (CTRF)](https://reqmd.xyz/quickstart/05-verification-results-ctrf/)
- [Step 6 — Review documentation](https://reqmd.xyz/quickstart/06-review-documentation/)

## Reference

- [Cheat sheet](https://reqmd.xyz/cheat-sheet/): Full command reference with example outputs and schema.yaml options — every command, every flag, every x-reqmd option.
- [Benchmarks](https://reqmd.xyz/benchmarks/): How fast is reqmd? Real numbers from a real run — from 249 requirements in 16 ms to 720,000 requirements in 7 seconds.
- [Compare](https://reqmd.xyz/compare/): How reqmd compares to sphinx-needs, OpenFastTrace, DOORS, Jama, Polarion — and why git-native beats database-backed.
- [FAQ](https://reqmd.xyz/faq/): What reqmd does, how the GitHub review workflow works, schema, CI, submodules, reqmd-import, and more.
- [About](https://reqmd.xyz/about/): Design principles (no lock-in, no database, per-directory schemas, dogfooding) and the self-hosting story.

## AI integration
- [reqmd-import](https://reqmd.xyz/import/): Source-code traceability — extracts Go and Python symbols into reqmd .md requirement files, closing the gap from code to spec.
- [AI & agents](https://reqmd.xyz/ai/): Why reqmd's plain-markdown + JSON format is the right substrate for AI-assisted spec workflows, the full command surface, schema reference, and a copy-pasteable AGENTS.md.