bench set-config

La commande insère ou met à jour une clé de configuration du site ou du bench. Le type de la valeur dépend de l’écriture et de --parse.

1 min de lectureMis à jour le 5 octobre 2026Source : docs.frappe.io

À quoi sert la commande

bench set-config insère ou met à jour des valeurs dans les fichiers de configuration. La même commande vise site_config.json du site ou common_site_config.json du bench. La priorité des clés est expliquée dans Configuration (site_config.json). La lecture se fait avec bench show-config.

Usage

terminal

bench set-config [OPTIONS] KEY VALUE

Option	Effet
`-g`, `--global`	Écrit dans la configuration commune du bench
`-p`, `--parse`	Interprète la valeur au lieu de la stocker comme chaîne. Sert aux dictionnaires et aux listes. S’appelait `--as-dict`.

true et false en minuscules sont des booléens. 1 et 0 sont stockés comme entiers. Beaucoup de drapeaux traitent 1 et 0 comme true et false, mais la source recommande les minuscules true et false, dont le type est explicite. Évitez True et False en majuscules, sauf avec --parse : sinon ils peuvent être stockés comme des chaînes.

Exemples

Tests sur un site, ou sur tous les sites. Chaque site_config.json reçoit "allow_tests": true :

terminal

bench --site {site} set-config allow_tests true
bench --site all set-config allow_tests true

La même clé dans la configuration commune. Chaque site peut lancer des tests, sauf s’il redéfinit la clé dans son propre fichier :

terminal

bench set-config -g allow_tests true

Un dictionnaire, lu ensuite par frappe.conf.backup.get("includes") :

terminal

bench --site {site} set-config backup '{"includes": ["Not", "ToDo"]}' --parse

Point d’attention

Sans -g, la valeur va dans le site indiqué. Avec -g, elle vaut pour le bench, et un site peut encore la remplacer. --parse est nécessaire pour qu’un objet JSON ne reste pas une chaîne.