Commandes Frappe

Périmètre

Bench charge frappe.utils.bench_manager (le texte colle « module » au nom). Cette page ne couvre que les commandes du dépôt frappe/frappe. Celles du projet bench sont dans Commandes bench. Quatre familles. --site prend le nom ou all quand l’opération le permet. Elles vivent dans frappe.commands.site.

Sites

bench new-site n’installe que le framework. Détail : new-site.

bench --site {site} backup efface par défaut les sauvegardes de plus de 24 heures. backup.

bench --site {site} restore exige au moins le fichier de base, extension sql.gz ou sql. Le texte écrit « of » au lieu de « or ». restore.

Depuis la v13, sauvegarde partielle via bench backup, restauration via bench partial-restore. partial-restore.

install-app suppose l’application déjà sur le bench. L’opération installe meta, modules et DocTypes. get-app est une commande bench. uninstall-app est destructif et sauvegarde avant. Depuis la v13, une app absente du bench peut quand même être retirée du site. uninstall-app.

migrate lance patches, schéma, fichiers, traductions et index. migrate et Migrations de base de données.

drop-site supprime la base et déplace le dossier vers ./archived_sites, sauf indication contraire. drop-site. bench reinstall {site} réinstalle les applications et remet le site à zéro. reinstall.

list-apps lit le DocType Installed Applications, ou à défaut installed_apps. Depuis la v13, --site all résume tous les sites. list-apps.

FRAPPE_SITE évite de retaper --site. L’exemple exporte mysite.localhost, ouvre bench console, et frappe.local.site vaut ce nom.

bench --site site.local browse, ou bench browse site.local, ouvre le navigateur. --user connecte. Le mode développeur à 1 permet n’importe quel utilisateur. Administrator passe même sans ce mode. L’URL de connexion, avec sid, n’est imprimée que pour Administrator. Exemple : http://site.local:8000/app?sid=.

Autres opérations : add-system-manager, add-user, add-to-hosts, build-search-index (sites web, voir Recherche plein texte), disable-user, publish-realtime, reload-doc, reload-doctype, remove-from-installed-apps (retire l’app de installed_applications), run-patch. execute: lance une instruction, l’exemple pose default_app à frappe pour l’utilisateur de session. migrate-to envoie le site vers un hébergeur. ngrok partage une URL temporaire. set-password, set-admin-password, set-last-active-for-user, start-recording, stop-recording, use.

Base

transform-database --tables change engine et row_format. transform-database.

trim-tables retire les colonnes de champs déjà enlevés du DocType. Elles restent par conception. Intérêt publié : sauvegardes plus petites et plus rapides, base plus légère, SELECT * plus juste, rien de caché. trim-tables.

trim-database retire les tables de DocTypes supprimés ou laissés par une migration. trim-database.

Planificateur

Module frappe.commands.schedule. disable-scheduler, doctor, enable-scheduler, purge-jobs (tout le site si l’option d’événement manque), ready-for-migration (jobs en attente), scheduler (pause, resume, disable, enable), set-maintenance-mode, show-pending-jobs, schedule (processus des événements de hooks.py), worker, trigger-scheduler-event. Le diagnostic est dans Diagnostiquer le planificateur.

Utilitaires

Module frappe.commands.utils. La config appliquée mélange common_site_config.json et site_config.json. show-config et set-config, ce dernier aussi pour la config commune. version : depuis la v13, -f / --format ajoute branche et dernier commit. La page officielle pointe une ancre bench-version.

Aussi : add-to-email-queue, build, bulk-rename (CSV sans en-tête : ancien nom, nouveau nom, Merge, l’exemple passe de HR-EMP-00001 à EMP0001, FALSE), clear-cache, clear-website-cache, console avec --autoreload, data-import, destroy-all-sessions, execute, export-csv, export-doc, export-fixtures (JSON définis dans hooks.py), export-json (- pour un Single), import-csv, import-doc (un dossier importe tous les .json), jupyter, make-app, db-console (alias de mariadb et postgres), mariadb, postgres, rebuild-global-search, request (la page écrit « Arguements »), reset-perms, run-tests, run-parallel-tests, run-ui-tests, serve, watch.

Traductions

Jusqu’à la v15, CSV. Depuis la v16, fichiers PO. Une app peut garder le CSV. Le détail des fichiers est dans Traductions.

CSV, module frappe.commands.translate : build-message-files, get-untranslated, migrate-translations, new-language, update-translations.

PO, module frappe.commands.gettext : generate-pot-file (le texte dit « serves a a » et « This is creates »), compile-po-to-mo (aussi lancé par bench build, le texte écrit « complied »), migrate-csv-to-po après le POT, update-po-files, create-po-file.

Point d’attention

browse --user pour un autre qu’Administrator exige developer_mode à 1. uninstall-app et reinstall effacent des données. trim-tables enlève des colonnes que les migrations laissent volontairement.