WordPress DevKit / Field guide

Discover the environment

Run Doctor, read its report and compare evidence over time.

Discover without loading WordPress

Run Doctor from the DevKit checkout, targeting your project and a separate evidence directory.

python scripts/doctor.py "C:\path\to\wordpress-project" --output "C:\path\to\evidence\doctor"

Doctor looks at the project layout and checks selected tool versions. It leaves secret and configuration values alone and does not load project code. It skips WP-CLI because local WP-CLI configuration can run PHP.

Read the report correctly

  • passed: the named check succeeded within its stated scope.
  • failed: an attempted check failed; Doctor returns exit 1.
  • unavailable: required tooling or evidence was absent.
  • skipped: the check was intentionally not run. This is not a compatibility pass.

Open report.html to read the results, and keep report.json if you want to use them with other tools. Finding a tool on your computer is just the first step; you still need to test your project. Invalid input returns exit 2.

Optional trusted container inventory

After inspecting and authorizing a trusted, explicitly named container, you can opt into WordPress bootstrap:

python scripts/doctor.py "C:\path\to\wordpress-project" --container owned-wordpress --trusted-runtime --output "C:\path\to\evidence\runtime"

Compare two reports

Use reports with the same stable target identity. Inspect version and fixture differences before interpreting a change.

python scripts/report.py "C:\path\to\current\report.json" --previous "C:\path\to\previous\report.json" --output "C:\path\to\comparison"

The comparison shows changes in check results, finding severity and remediation. If a finding disappears, check the fix before marking it resolved.

Know which installation you checked

A container report records the selected WordPress root. Compare reports from the same root to avoid mixing two installations. A theme without a version header keeps an empty version; Doctor does not guess one.