Quick Start
Run Doctor from the target project root:
pnpm dlx vite-doctor . # or npx/bunx/yarn dlx
For Nuxt projects, the recommended workflow is:
pnpm add -D vite-doctor
export default defineNuxtConfig({
modules: ["vite-doctor/nuxt"],
});
pnpm nuxt doctor
The standalone CLI also works for Nuxt one-off runs, CI fallback, or monorepo scans.
Workflow
- Run Doctor against the target project or package; install dependencies first if needed.
- Read each Diagnostic Code,
why,fix, docs URL, severity, confidence, and source location. - Open
https://vite-doctor.onmax.me/diagnostics/CODEbefore recommending remediation. - Prefer the smallest fix that addresses the Diagnostic and preserves project conventions.
- Run the narrowest relevant verification after editing.
- Use
--format jsonor--format sarifonly when structured output is needed.
Rules
- Use
vite-doctorfor Vite, Vue, Nitro, and Nuxt projects; do not invent framework-specific packages or binaries. - Treat Rule IDs as execution/filtering selectors.
- Treat Diagnostic Codes as the stable remediation identity for docs, fixes, and user-facing explanations.
- Use Doctor terms consistently: Doctor, Rule, Rule Pack, Diagnostic Code, and Diagnostic.
- Keep code edits scoped to reported Diagnostics unless the user asks for broader cleanup.