StraitjacketDocumentation
Everything on running Straitjacket — tutorials, how-to guides, reference, and the reasoning behind the rules.
Straitjacket is a fast, deterministic scanner that flags the weird code and text LLMs like to produce. It sweeps your files against a set of rules — with snobby yet configurable defaults — and flags anything it finds. It's a single static Rust binary with no runtime dependencies, so it drops into almost any environment or repo's CI, regardless of language or stack.
Like Straitjacket?
Try out PowderMonkey — a (straitjacketed) agent orchestration harness for aspiring slop cannons.
These docs follow the Diátaxis framework — four kinds of documentation, each answering a different question:
Tutorials
Learning-oriented. Start here: install Straitjacket and run your first scan end to end.
How-to guides
Task-oriented recipes: wire it into CI, suppress a false positive, exclude generated files, tune the rules.
Reference
Information-oriented. Every rule, every CLI flag, every Action input, and the exact suppression-marker syntax.
Explanation
Understanding-oriented. How slop-prose scoring works, why duplication is compiled in, and the thinking behind the React rules.
About
Background & philosophy, how to contribute a new smell, and the license.
In a hurry?
# install (Linux x86_64, macOS arm64/x86_64)
curl -fsSL https://raw.githubusercontent.com/zmaril/straitjacket/main/install.sh | sh
# scan the current directory (honors .gitignore)
straitjacketEverything is on by default — Straitjacket runs at its max, and you ratchet down
with --skip. See the Getting started tutorial
for a guided walkthrough.