paramour doctor
Diagnose the project's paramour setup — one pass, one report.
Diagnoses the whole setup in one pass. When something about a project feels off, run doctor before debugging by hand — it checks the boring causes first:
npx paramour doctor ✔ config: no paramour.config file — defaults in effect
✔ route directories: app/
✔ artifact: paramour-env.d.ts is up to date
✔ next.config: next.config.ts wraps withTypedRoutes
✔ versions: paramour and @paramour-js/next are both 1.0.0
✔ skills: .claude/skills/paramour is up to date
✔ tsconfig: tsconfig.json includes paramour-env.d.ts
✔ route definitions: 3 found in 3 modules
3 of 3 filesystem routes have definitions
doctor: 8 checks — 0 failed, 0 warnings(The sample shows a project with skills installed in one tool directory;
each additional installed skills target adds its own skills line to the
count.)
Each check degrades independently — doctor exists to diagnose broken setups, so a probe that itself throws becomes a finding, never a crash.
The checks
Seven fixed checks plus one skills check per installed skills target,
in report order — so eight is the floor, not the total: a project that
never installed skills (or has no agent tooling) still gets a single
summary skills line, while one with copies in both .claude/ and
.cursor/ reports nine. A trailing slash line follows the others only
when it has an answer (see its row). fail means a verification you care
about is untrue; warn is advisory and never affects the exit code.
| Check | Verifies | Can fail? |
|---|---|---|
config | paramour.config.{ts,mjs,json} parses and validates (no config at all is a pass — defaults in effect). | fail |
route directories | An app and/or pages directory resolves, config dirs honored. | fail |
artifact | The artifact exists and is current — the check engine; drift details name the routes. | fail |
next.config | The config file wraps withTypedRoutes. Warn-level only: CLI-only workflows (generate in a script, check in CI) are legitimate. | warn only |
versions | paramour and @paramour-js/next resolve in node_modules (fail if not), and the two are the same version (warn on mismatch — the paramour packages release in lockstep, so a mismatch means a half-upgraded app). | fail |
skills | Installed agent skills match this package's bundled content — one check line per installed target. Warn-level only: stale guidance degrades agent output but breaks nothing, and the deliberate CI gate is skills --check. Projects without agent tooling (or that never installed skills) get a pass line, not a nag. | warn only |
tsconfig | The tsconfig covers the artifact file, so the registry augmentation is actually in your program. | warn only |
route definitions | Route-definition discovery is healthy — how many definitions found, how many filesystem routes they cover, plus load failures and duplicates. Evaluates matched modules, like list. | warn only |
trailing slash | Every discovered route definition's trailingSlash matches trailingSlash in next.config; each route that disagrees is listed with the fix. Reported only when definitions exist and the config value reads statically: an object literal, possibly behind single-argument wrapper calls, satisfies, or a top-level const (no key means Next's default, false). A config function, a spread, a wrapper call with more than one argument (withPlugin(options, config)), or a config object changed after its declaration (config.trailingSlash = true, Object.assign(config, …)) gives no line rather than a guess. | warn only |
Flags
| Flag | Default | Description |
|---|---|---|
--json | off | Machine-readable output. |
--help, -h | — | Show usage. |
--json emits { checks, status }, where each check carries label,
status ("pass" / "warn" / "fail"), and optional detail lines, and
the top-level status is the worst of them.
Exit codes
Doctor is a verification, so its exit codes follow check's class:
| Code | When |
|---|---|
0 | Every check passed — warnings allowed. |
1 | Any check failed. |
2 | Doctor itself could not run (usage errors, an unexpected crash). |
Because warnings exit 0, doctor can run in CI as a broader gate than
check without failing builds over advisory findings.