PI-DOCTOR(1)

NAME
pi-doctor - read-only Raspberry Pi diagnostics

SYNOPSIS
pi-doctor [OPTIONS] COMMAND

DESCRIPTION
pi-doctor checks common Raspberry Pi support issues without changing the host system. It reports board identity, kernel and distribution metadata, firmware throttling signals, thermal state, boot configuration drift, GPIO tooling, camera detection, and Python environment state.

COMMANDS

check
    Run the full diagnostic probe set.

explain throttling
    Explain firmware throttling and thermal diagnostics.

explain config
    Explain Raspberry Pi boot configuration diagnostics.

explain python
    Explain Python environment diagnostics.

doctor camera
    Run focused camera diagnostics.

doctor gpio
    Run focused GPIO diagnostics.

support-bundle
    Create a diagnostic bundle. Bundles are sanitized by default and include a manifest with SHA-256 hashes.

completions SHELL
    Generate shell completion scripts.

OPTIONS

--json
    Emit JSON output for check.

--quiet
    Use compact human output.

--verbose
    Use verbose human output.

--no-color
    Disable color in human output.

--timeout SECONDS
    Set the per-command probe timeout.

support-bundle --output DIR
    Write the bundle under DIR instead of the current directory.

support-bundle --dry-run
    Show exactly which files would be collected without writing a bundle.

support-bundle --include-sensitive --acknowledge-sensitive-data
    Disable redaction for expert support cases. This may include hostnames, paths, serial numbers, URLs, tokens, and raw command output.

-h, --help
    Show command help.

-V, --version
    Show the package version.

EXIT STATUS
The check command exits with 0 for healthy, 1 for warning, 2 for degraded, and 3 for critical status. Unexpected runtime failures exit with 4.

SEE ALSO
Project documentation is installed under /usr/share/doc/pi-doctor/.