Appearance
Lawcheck
You write down the architecture and the rules of your repository. Lawcheck checks your code against them. It tells your coding agent which line breaks which rule.
A law and a finding
This law keeps the core of a shop apart from its commands. Files of the type core may use only files of core:
yaml
lawcheck: 0.1.0
types:
core:
about: Prices and orders, with no input or output.
paths: ["src/core/**"]
may_use: [core]
cli:
about: The commands, which read input and print.
paths: ["src/cli/**"]On a branch made from main, a new file src/core/receipt.ts imports print from ../cli/print.js. The check names that line:
text
$ lawcheck check --base mainoutput
lawcheck: FAIL 1 error in 1 changed file (against main)
src/core/receipt.ts:1 error[forbidden-use] core may not use cli (src/cli/print.ts); its may_use is [core]
why: a type's may_use names every type its files may use
next: fix src/core/receipt.ts:1The run exits 1. The finding gives the file, the line, the code forbidden-use and the may_use list of core.
Where it checks
- Claude Code: the plugin checks each file the agent edits. When the agent is about to finish its answer to your prompt, the plugin checks every file the agent changed for that prompt. While those files break the law, the plugin sends the agent back to work, up to three times.
- Any other agent: one line in its instructions file tells the agent to run
lawcheck prime. That command prints the law and the commands that check it. - CI:
lawcheck check --base origin/mainjudges the files of the pull request. It needs no key and no network.
Try it
text
npm install --global lawcheck@alpha
lawcheck docs quick-startThe quick start ends on a rule about which layer may import which. For a first rule about the text of a file, such as no console.log in one folder, read The first type and the first rule or run lawcheck docs first-law.
Lawcheck is an alpha. It needs Node 24 or later and git 2.34 or later.
Lawcheck sends code to a model only when you ask the model to judge a rule written in prose. A script rule is code of your own repository. When Lawcheck runs one, the rule can read any file under the root of the law. On Node 24, a script rule can open a network connection. On Node 25 and later, the permission model of Node refuses that connection.
Read next
- Quick start takes a new repository to its first finding in five steps. You need no model and no key.
- The first type and the first rule writes a script rule and shows the check that fails on its first finding.
- Concepts defines the twelve words these pages use, each with one example.
- Lawcheck and the tools you already use compares Lawcheck with a rules file, an architecture linter, a review bot and a hook of your own.
Limits
- After it has sent the agent back three times, the plugin lets the agent finish. The plugin tells you that the check still fails (The Claude Code plugin).
- A pull request can edit the law that judges it.
checkprints what the pull request does to that law (What a check judges). The CI job of CI and git hooks checks the pull request a second time, with the law of the base. - Lawcheck reads the uses written out in the code. It does not read an
import()of a variable,importlib.import_module, or a class that the code finds by its name at run time (Languages and uses).
Next: Install