The report's share button, and --share-sections on the CLI, write a JSON slice of a scan: pick the score, a findings category, the endpoints, the schema, or the module graph. Sharing docs →

Add a few lines to main.ts, boot once, and --timings gives the report a Boot trace tab. Every class sits on one absolute timeline, with a hover card per bar and graph nodes that say what each module cost. Boot trace docs →

3. Run in CI

Write .github/workflows/nestjs-doctor.yml:

npx nestjs-doctor@latest ci install

The action reviews every pull request and reports only what the change introduced, not the existing backlog. It posts a sticky summary comment, inline review comments on the changed lines, and a commit status with the score.

It never fails a check until you ask it to. Set blocking or min-score when ready. CI docs →

4. Install for agents

Install the agent skill:

npx nestjs-doctor@latest --init

Installs three skills: nestjs-doctor for scanning after a change, nestjs-boot-trace for a slow start, and nestjs-doctor-create-rule for conventions of your own. The first runs without being asked, after the agent writes Nest code. Works with Claude Code, Cursor, Codex, OpenCode, Windsurf, Gemini CLI, and more. Agent docs →

5. Configure rules

Optional. Drop a nestjs-doctor.config.json at your project root to turn rules or categories off, set a score floor, or point at a custom rules directory:

{
  "minScore": 80,
  "rules": {
    "performance/no-sync-io": false,
    "architecture/no-manual-instantiation": {
      "excludeClasses": ["Logger", "PinoLogger"]
    }
  },
  "categories": { "performance": false }
}

The same shape works as .nestjs-doctor.json, or as a "nestjs-doctor" key in package.json.

Configuration → · Custom rule configuration →

Rules

52 built-in rules. Every finding carries a file and a rule id you can suppress or configure, plus a line unless it reports against a schema entity.

Suppress a single finding inline:

// nestjs-doctor-ignore-next-line architecture/no-orm-in-controllers
constructor(private readonly prisma: PrismaService) {}

Editors and tooling

• VS Code: NestJS Doctor surfaces the same rules as you type. Docs →
• Any other editor: npx nestjs-doctor-lsp --stdio speaks LSP, so Neovim, Helix, and Emacs get the same rules. Docs →
• Other CI: GitLab Code Quality, SARIF for any code-scanning backend, or a markdown body to post yourself. Docs →
• Node API: diagnose() plus an incremental API for editors and long-running processes. Docs →
• Monorepos: detected from nest-cli.json, pnpm workspaces, package.json workspaces, Nx, or Lerna. Docs →

Contributing

Issues and pull requests welcome. pnpm check && pnpm typecheck && pnpm test before opening one.

MIT © RoloBits