# spec family

A specification marks a feature `Implemented`, and no test that could fail
stands behind it. An agent asked to fix one function also rewrites the
migration its task told it to leave alone. An ADR says the domain imports
nothing from the infrastructure, and the code stopped keeping that a month
ago. Each is a Markdown document saying something about the code that is not
true, and nothing in the build notices.

**The spec family finds each of these, the same way every time: it holds your code, and the agents that write it, to what your Markdown says.**

[Read the overview](https://github.com/spec-family/spec-core/blob/main/docs/overview.md) [The tools on GitHub](https://github.com/spec-family)

It is four command-line tools. They read the Markdown a repository already
keeps - specifications, ADRs, checklists, registers, agent instructions, the
brief a round of agent work runs under - and check what it says against the
code, the git history and the changes an agent actually made. They call no
model, need no account and make no network request. A tool's exit code means
one thing: `0` clean, `1` found something, `2` the result cannot be trusted.

## Install one

```sh
npm install --save-dev @spec-family/spec-guard
npx --no-install @spec-family/spec-guard
```

Each tool is one npm package under the `@spec-family` scope: spec-brief,
spec-graph, spec-guard and spec-harness; put the one you want in place of
spec-guard. `--no-install` runs the copy your project installed, and never
fetches a package of a similar name. The tools need Node 22 or later.

**0 runtime dependencies** in the four tools, at the releases this site pins: each release's manifest on the npm registry lists no `dependencies`. spec-harness asks for spec-brief beside it, and spec-graph and spec-guard where they are installed, as peers. No release names a package from outside the family. Reproduce it from the manifests: [spec-brief 0.15.0](https://registry.npmjs.org/@spec-family%2fspec-brief/0.15.0), [spec-graph 0.26.0](https://registry.npmjs.org/@spec-family%2fspec-graph/0.26.0), [spec-guard 0.35.0](https://registry.npmjs.org/@spec-family%2fspec-guard/0.35.0), [spec-harness 0.26.0](https://registry.npmjs.org/@spec-family%2fspec-harness/0.26.0).

## Where to go next

- [Which document do you want to keep true?](https://spec-family.github.io/documents/index.md) Eight kinds of
  document, the tool that holds each, and its rules.
- [Two stories](https://spec-family.github.io/stories/index.md): an agent's write refused, and a claim with
  nothing behind it turned red in CI, each with what the tools printed.
- [The four tools](https://spec-family.github.io/tools/index.md): one command each, and what the pinned release
  prints.
- [Comparison and limits](https://spec-family.github.io/compare/index.md): the projects nearby, and what the tools
  do not do.

Every command's output on this site is printed by the tools themselves, at
the releases each page names (spec-brief 0.15.0, spec-graph 0.26.0, spec-guard 0.35.0 and spec-harness 0.26.0), in the site's CI; a release that
prints something else turns the site's build red until the page is played
again.

---

This is the Markdown version of https://spec-family.github.io/. Every command's output in it is printed by spec-brief 0.15.0, spec-graph 0.26.0, spec-guard 0.35.0 and spec-harness 0.26.0 in the site's CI; [llms.txt](https://spec-family.github.io/llms.txt) lists every page.
