Skip to content
Back to search

compadr

Know what was decided, and whether the code still follows it. Compadr keeps architecture decision records true to the code.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/designhorizondev--compadr/badge.svg)](/listings/designhorizondev--compadr)

HTML

<a href="/listings/designhorizondev--compadr"><img src="/api/listings/designhorizondev--compadr/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

npm install --save-dev @compadr/cli
npx compadr --help

The command line needs Node 24 and git.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 71 lines
  1. <h1 align="center">
  2. <picture>
  3. <source media="(prefers-color-scheme: dark)" srcset="packages/tokens/assets/logo-dark.svg">
  4. <img alt="Compadr" src="packages/tokens/assets/logo-light.svg" width="320">
  5. </picture>
  6. </h1>
  7. <p align="center">Know what was decided, and whether the code still follows it.</p>
  8. Compadr links each architecture decision record (ADR) to the code it governs, reports when the code moves away from it, and gives your coding agents the decisions in force before they write. The git repository stays the source of truth.
  9. - **Drift you can trust.** Compadr dates each reference to the code. Only certain problems fail the check: a cited path that is gone, or a superseded decision that the code still cites.
  10. - **A check on each pull request.** With `--base`, a pull request fails on what it adds, and not on the history it starts from.
  11. - **A memory for your agents.** A local MCP server gives an agent the decisions that apply to a file, each with a one-sentence rule.
  12. - **One page per feature.** The local console groups the decisions by feature and shows the rules in force after a chain of amendments.
  13. Compadr reads adr-tools, MADR and Log4brains records as they are.
  14. ## Install
  15. ```bash
  16. npm install --save-dev @compadr/cli
  17. npx compadr --help
  18. ```
  19. The command line needs Node 24 and git.
  20. ## First steps
  21. ```bash
  22. # Report what no longer holds
  23. npx compadr drift . --out /tmp/drift.json
  24. # Fail a pull request on the problems that it adds
  25. npx compadr check . --base origin/main
  26. # Give the decisions to Claude Code
  27. claude mcp add compadr -- npx compadr mcp .
  28. ```
  29. The [documentation](https://compadr.io/docs/) covers the check in CI, the anchored references, the features, the MCP server and the console. The [reference](docs/reference.md) describes every command and file.
  30. ## Compadr never writes to your working copy
  31. The engine only reads the repository that it analyses. A command that corrects a record works in a temporary clone, commits on a new branch and pushes it only when you ask for it. Nothing leaves your machine unless you push a draft or turn on the AI option in `compadr.yml`.
  32. ## Packages
  33. | Package | Role | License |
  34. |---|---|---|
  35. | [`@compadr/format`](packages/format) | Decision record format: `compadr:` fields, supported ADR dialects, JSON schemas of the reports | Apache-2.0 |
  36. | [`@compadr/engine`](packages/engine) | Deterministic, read-only drift engine | FSL-1.1-ALv2 |
  37. | [`@compadr/cli`](packages/cli) | `compadr` command line | FSL-1.1-ALv2 |
  38. | [`@compadr/mcp`](packages/mcp) | Local MCP server for coding agents | FSL-1.1-ALv2 |
  39. | [`@compadr/assist`](packages/assist) | Client of the assist service of the AI option | FSL-1.1-ALv2 |
  40. | [`@compadr/tokens`](packages/tokens) | Design tokens of the console: colors, fonts, radii, logo and favicon | FCL-1.0-ALv2 |
  41. | [`@compadr/console`](packages/console) | Local web console of the drift reports | FCL-1.0-ALv2 |
  42. npm publishes `@compadr/cli`, `@compadr/console` and `@compadr/format`. The command line and the console bundle the other packages.
  43. The team portal and the hosted service are commercial products, and their code is not in this repository. The [pricing page](https://compadr.io/pricing/) describes them.
  44. ## Licenses
  45. The format is under the Apache License 2.0. The engine, the command line, the MCP server and the assist client are under the Functional Source License (FSL-1.1-ALv2). The console and its design tokens are under the Fair Core License (FCL-1.0-ALv2). Under the FSL and the FCL, each version becomes available under the Apache License 2.0 two years after its release.
  46. [LICENSING.md](LICENSING.md) explains what each license allows. [TRADEMARK.md](TRADEMARK.md) covers the name and the logo.
  47. ## Contributing
  48. Questions and bugs go to the [issues](https://github.com/DesignHorizonDev/compadr/issues). [CONTRIBUTING.md](CONTRIBUTING.md) describes how to build the repository and how to propose a change. [SECURITY.md](SECURITY.md) describes how to report a vulnerability.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.