Aide-mémoire des commandes bench

Général

Un PDF A4 des commandes principales est lié : Bench Cheatsheet v1.1.pdf. La page officielle le sert sous /files/. Les commandes détaillées sont dans Commandes bench.

bench --version affiche la version de bench, bench version celle des applications, bench src le dépôt, bench --help toutes les commandes, bench [command] --help l’aide d’une commande. bench --site [site-name] COMMAND vise un site.

bench init [bench-name], depuis le dossier personnel. Options publiées : --python, --ignore-exist, --apps_path, --frappe-path, --frappe-branch, --clone-from, --clone-without-update, --verbose, --skip-redis-config-generation si le common-site-config est déjà donné. Trois libellés publiés ne correspondent pas au nom : --no-procfile est décrit comme tirer les changements, --no-backups comme lancer les migrations, --no-auto-update comme construire JS et CSS. Ce sont les textes de --pull, --patch et --build de bench update.

bench update tire bench et les applications, applique les patches, construit JS et CSS, migre. Options : --pull, --patch, --build, --bench, --requirements, --restart-supervisor, --no-backup, --reset (ignore les changements locaux), --dev (mode développeur et dépendances de test).

bench restart relance les services. bench backup sauvegarde le site par défaut dans ~/frappe-bench/sites/{your site}/private/backups/. bench backup-all-sites a --with-files. bench restore a --with-private-files et --with-public-files. bench migrate lance patches, schéma, fichiers et traductions, avec --rebuild-website. bench migrate-env [python-version] change l’environnement. bench --site [sitename] set-admin-password [password] réinitialise l’administrateur. bench destroy-all-sessions détruit les sessions.

Config et setup

bench config : auto_update, dns_multitenant, http_timeout, restart_supervisor_on_update, serve_default_site (la phrase publiée s’arrête à « serve the default site on »), update_bench_on_update. Valeurs on/off là où c’est indiqué.

bench setup : auto-update, backups, config, env, nginx, procfile, production, redis, socketio, sudoers, supervisor, add-domain, firewall (ne laisse que 22, 80 et 443), ssh-port, requirements. Ce dernier a --node, --python, --dev. bench set-nginx-port [sitename] [port] fixe le port de production.

Développement

bench new-app, bench get-app avec --branch, bench install-app, bench remove-from-installed-apps, bench uninstall-app (le bench doit tourner), bench remove-app. bench --site [sitename] --force reinstall repart d’une base vide et efface l’ancienne. bench new-site : --db-name, --db-host, --db-port (autre que 3306), --mariadb-root-username, --mariadb-root-password, --admin-password, --verbose, --force, --source_sql, --install-app (le texte publié a un accent grave en trop). bench use choisit le site par défaut. bench drop-site a --root-login et --root-password. bench set-config ajoute une clé. bench console ouvre IPython, --autoreload recharge le code. bench execute lance une méthode, exemple frappe.utils.scheduler.enqueue_scheduler_events. bench --site [sitename] mariadb ouvre SQL. bench export-fixtures exporte les enregistrements des hooks, option --app.

bench run-tests : --app, --doctype, --test, --module, --profile. bench disable-production quitte la production. bench serve écoute 0.0.0.0, port 8000 par défaut. --profile mesure les méthodes, --proxy pour ngrok ou localtunnel, --noreload, --nothreading (le PDF peut alors se comporter mal), --with-coverage écrit sites/coverage.xml et active --noreload et --nothreading.

Planificateur et import

bench enable-scheduler, bench doctor, bench show-pending-jobs, bench purge-jobs. bench data-import lit csv, xls ou xlsx, avec --file, --doctype, --type Insert ou Update.

Point d’attention

reinstall --force efface la base. Les trois options d’init citées portent, dans cette page, le texte d’options de update.