cuda-doctor logo

Repository contract

Metav0.0.0

README.md

README.md is the canonical product brief. It explains that cuda-doctor is a diagnose + repair + build + validate CLI, frames the Blackwell and fake-success failure modes it targets, and sketches the command surface the rest of the repo is trying to implement.

Reference

This file is the product-level map for the repository, not just an installation note.

  • Defines what cuda-doctor is and what it is not.
  • Names the critical failure classes: Blackwell readiness, missing `sm_120`, driver/runtime drift, wrong kernel module flavor, and fake-success installs.
  • Documents the intended command suite: `doctor`, `doctor auto`, `check`, `setup`, `build`, and `validate`.

Why this file matters

The rest of the codebase only partially implements the command model today. README.md matters because it tells you which parts are already live, which ones are intended next, and what the real success bar is: proving actual GPU execution instead of trusting superficial tooling output.

Search anchor

Users looking for high-level terms like `sm_120`, `Blackwell`, `doctor auto`, or `fake success` should land here or on the specific implementation files that follow from this contract.

Relationships

Command contract

README promises commands that `src/main.cpp` and the `src/commands/*` tree must eventually expose.

Repair policy

The compatibility-aware repair stance in the README is currently closest to the repo patching work in `src/core/repo.cpp` and environment setup in `src/core/configure.cpp`.

Validation-first philosophy

The README’s emphasis on real execution explains why future kernel and validate files exist even when they are still placeholders.