Functional Specification

Commands

CommandPurposeWrites
doctorPrint version, platform, implemented and planned featuresstdout
versionPrint the versionstdout
scan --root P --out F [--format json,md,html]Static scanone file
plan --root P --scan F --target T --out FPlan for one changeone file
rehearse --root P --plan F --out FTemp-dir rehearsalone file
gate --plan F --rehearsal F --out F [--evidence F]Release-gate reviewone file
compare --before F --after F --out FDiff two scansone file
render --input F --out F --format md,htmlRe-render any reportone file
audit --root P --out DIR [--target T] [--fail high]scan + plan + rehearse + gate in one stepaudit.json, audit.md, audit.html
skills --host H --root PCopy skills into an IDE pathskill folders
serve --report F --port NLocalhost read-only APInone

Targets: npm:package@1.2.3 or node:22. Anything else is refused.

Exit codes: 0 success, 1 audit --fail high found a high finding, 2 error.

Inputs read

Only these root files are read: package.json, lockfiles, requirements.txt, pyproject.toml, go.mod, pom.xml, build.gradle(.kts), composer.json, Dockerfile, .tool-versions, plus .sql files under migrations, db/migrations, prisma/migrations and database/migrations. .env and other files are never read.

Rule catalogue

Rule IDSeverityMeaning
SQL_DROP_TABLEhighDestructive table drop
SQL_DROP_COLUMNhighDestructive column removal
SQL_TRUNCATEhighDestructive truncate
SQL_DELETE_UNSCOPEDhighDELETE with no WHERE in the statement
MANIFEST_PARSEhighInvalid JSON manifest
SQL_NOT_NULL_NO_DEFAULTmediumNOT NULL column added without DEFAULT
SQL_RENAMEmediumRename breaks mixed-version readers
NPM_NONREPRODUCIBLEmedium*, latest, next, file:, git or URL dependency
NPM_NO_LOCKFILEmediumDependencies but no root lockfile
PYTHON_UNPINNEDmediumRequirement not pinned with ==
DOCKER_UNPINNED_BASEmediumBase image has no tag, uses latest, or lacks a digest
SOURCE_NOT_READmediumFile was refused (symlink, too large)
SQL_INDEX_NOT_CONCURRENTlowCREATE INDEX without CONCURRENTLY (PostgreSQL concern)

Comments and single-quoted strings are blanked before matching.

Verdicts

VerdictWhen
NO_GOAny high static finding, or the static rehearsal failed
REVIEW_REQUIREDEverything else. Tests and rollback are always NOT_RUN, so this is the ceiling
GO_CANDIDATENot implemented. Reserved for a future policy with verified test evidence

Imported evidence passed to gate --evidence is labelled UNVERIFIED_EXTERNAL and never raises the verdict.

Acceptance behaviors