Bench structure checks
Checks apps and sites directories, Procfile, the app registry and discovered site configuration files.
Day 021 / Frappe / ERPNext Utilities
Bench Doctor Lite
/ Overview
A read-only Python CLI that checks a Frappe bench’s structure and configuration health without exposing configuration values.
A Frappe bench can look intact while expected directories, app registries, JSON configuration or scheduler state contain simple problems. Ordinary troubleshooting can also expose passwords when full configuration files are printed.
/ Provided servicesClear thinking.
Clear thinking.
Practical delivery.
Privacy-conscious diagnostics
Reports key counts and health statuses while deliberately omitting database passwords and every other configuration value.
Automation-ready reporting
Produces stable text or JSON output with distinct exit codes for clean checks, findings and invalid input.
/ Solution
Bench Doctor Lite performs a read-only structural inspection of a chosen bench directory. It checks expected folders and files, validates common and per-site JSON, identifies a paused scheduler flag, counts local apps and reports only statuses, paths and key counts—not configuration values.
/ Impact
Read-only bench inspection
Structural and JSON checks
Paused-scheduler warning
Configuration values omitted
Nine passing standard-library tests
Python standard library
Pathlib, json, argparse and dataclasses provide the full read-only diagnostic without external packages.
Frappe bench conventions
The checks model common bench folders, app registries, common configuration and per-site configuration files.
Unittest
Nine temporary-fixture tests cover missing structure, invalid JSON, empty registries, scheduler state, value omission and exit codes.