bench show-config
The bench show-config command displays the effective configuration applied to a Frappe site. It combines settings from the bench-level common_site_config.json and the site’s own site_config.json, showing the final configuration that Frappe uses at runtime.
The output can be displayed in either a human-readable table or JSON format, making it useful for troubleshooting and configuration verification.
Usage
bench show-config [OPTIONS]How It Works
Every Frappe site uses configuration values from two files:
common_site_config.json– Stores configuration shared across all sites in the bench.site_config.json– Stores configuration specific to an individual site.
The bench show-config command merges these settings and displays the final values that are currently applied to the selected site.
Note:
If the same configuration key exists in both files, the value from site_config.json takes precedence over common_site_config.json.
Available Option
| Option | Description |
|---|---|
-f, --format |
Specifies the output format. Supported values are text and json. The default format is text. |
Examples
Display Configuration for All Sites in JSON Format
View the effective configuration for every site in the current bench as JSON.
bench --site all show-config -f jsonDisplay Configuration in Text Format
Show the site’s configuration in an easy-to-read tabular format.
bench --site {site} show-config --format textYou can also use the short option:
bench --site {site} show-config -f textUse the Default Output Format
If no format is specified, Bench displays the configuration in the default text format.
bench --site {site} show-configTip:
Use bench show-config when debugging site behavior or verifying configuration values after modifying common_site_config.json or site_config.json.
