xspec build, and get back a fully typed TypeScript module for each spec file — giving you import-time references that your compiler can check, your coverage tool can measure, and your CI pipeline can gate on. Instead of relying on naming conventions or manual bookkeeping, xspec builds an explicit graph that makes requirement traceability a first-class part of your development workflow.
Introduction
Learn what xspec is, why it exists, and the core ideas behind typed requirement traceability.
Quickstart
Install xspec and trace your first requirement from spec to code to coverage in under ten minutes.
Writing Specs
Discover the MDX syntax for authoring nested, tagged, richly linked specification documents.
CLI Reference
Explore every xspec command: build, check, coverage, impact, and more.
Get up and running in four steps
Whether you are adding xspec to an existing project or starting fresh, the onboarding path is the same short sequence below.1
Install xspec
Clone the repository, build it, and link the binary onto your
PATH with npm link.2
Create your config
Add an
xspec.config.ts file at the root of your workspace that points xspec at your spec files, source code, and test files.3
Write your first spec
Author an MDX file under your
specs/ directory using the <S> component to declare nested, identifiable requirements.4
Build and measure
Run
xspec build to generate typed modules and the project graph, then xspec coverage tested --check to enforce that every requirement is tested.