Skip to content

Doctor

doctor is a deterministic readiness verifier for release confidence.

Commands

  • sdetkit doctor --all --format json
  • sdetkit doctor --dev --ci --deps --clean-tree --repo --format md
  • sdetkit doctor --upgrade-audit --upgrade-audit-offline --format json
  • sdetkit doctor --upgrade-audit --upgrade-audit-query quality --upgrade-audit-impact-area quality-tooling --upgrade-audit-top 5 --format md
  • sdetkit doctor --upgrade-audit --upgrade-audit-manifest-action refresh-pin --upgrade-audit-top 3 --format json
  • sdetkit doctor --only pyproject --format json
  • bash quality.sh doctor

Contract

  • JSON output includes schema_version: sdetkit.doctor.v2.
  • Stable check IDs and deterministic JSON ordering.
  • Explicit failure classification in JSON error payloads (for example: plan_id_mismatch).
  • Exit codes:
  • 0: all selected checks passed
  • 2: one or more selected checks failed, or contract mismatch in apply-plan flow

Real-world depth

doctor checks production-relevant failure modes:

  • toolchain availability and virtualenv posture
  • dependency graph consistency
  • repo cleanliness + release metadata
  • CI + governance file integrity
  • stdlib-shadowing and non-ASCII hygiene

Each failing check includes actionable remediation (fix) and supporting evidence.

When --upgrade-audit is enabled, doctor also emits ranked dependency-maintenance hints with repo impact areas, recommended lanes, and validation commands so dependency planning becomes part of the same readiness report. The upgrade-audit metadata now also carries lane and impact summaries, so doctor recommendations can call out quality-tooling, runtime-core, and integration-adapter work with concrete follow-up commands instead of only listing raw packages.

Doctor also exposes focused upgrade-audit controls directly from the readiness surface:

  • --upgrade-audit-query to search across package names, lanes, notes, usage files, and commands.
  • --upgrade-audit-impact-area to zoom into runtime-core, quality-tooling, integration-adapters, and other repo impact maps.
  • --upgrade-audit-manifest-action to isolate pin refresh, floor raise, staged upgrade, and major-planning work.
  • --upgrade-audit-top to trim the result set to the highest-risk matching packages.

All output formats now include a quality summary that reports pass/fail/skipped check counts, pass rate, highest failure severity, failing check IDs, and hint/fix/evidence coverage.

Determinism

  • Baseline snapshots are emitted with stable key ordering.
  • Check collections are explicitly ordered.
  • Snapshot diff output is normalized for reproducible CI gating.