Quick Reference Guide

General Usage

• bench --help - Show all commands and help
• bench [command] --help - Show help for command
• bench --site [site-name] COMMAND - Specify site for command
• bench update - Pulls changes for bench-repo and all apps, applies patches, builds JS and CSS, and then migrates.
  • --pull Pull changes in all the apps in bench
  • --patch Run migrations for all sites in the bench
  • --build Build JS and CSS artifacts for the bench
  • --bench Update bench
  • --requirements Update requirements
  • --restart-supervisor restart supervisor processes after update
  • --upgrade Does major upgrade (Eg. ERPNext 6 -> 7)
  • --no-backup Don't take a backup before update
• bench migrate Will read JSON files and make changes to the database accordingly
• bench set-mariadb-host set mariaDB Host if you install database on different host

Config

• bench config - Change bench configuration
  • auto_update [on/off] Enable/Disable auto update for bench
  • dns_multitenant [on/off] Enable/Disable DNS Multitenancy
  • http_timeout [?] Set http timeout
  • restart_supervisor_on_update Enable/Disable auto restart of supervisor
  • serve_default_site Configure nginx to serve the default site on
  • update_bench_on_update Enable/Disable bench updates on running bench...
• bench setup - Setup components
  • auto-update Add cronjob for bench auto update
  • backups Add cronjob for bench backups
  • config overwrite or make config.json
  • env Setup virtualenv for bench
  • nginx generate config for nginx
  • lets-encrypt [site-name] create and config SSL certificate for site-name
  • procfile Setup Procfile for bench start
  • production setup bench for production
  • redis generate config for redis cache
  • socketio Setup node deps for socketio server
  • sudoers Add commands to sudoers list for execution...
  • supervisor generate config for supervisor

Development

• bench new-app [app-name] Creates a new app
• bench get-app [app-name] [repo-link] - Downloads an app from an online git repository and installs it
• bench install-app [app-name] Installs existing app
• bench remove-from-installed-apps [app-name] Remove app from the list of apps
• bench uninstall-app [app-name] Delete app and everything linked to the app
• bench new-site [sitename] - Creates a new site
  • --db-name Database name
  • --mariadb-root-username Root username for MariaDB
  • --mariadb-root-password Root password for MariaDB
  • --admin-password Administrator password for new site
  • --verbose Verbose
  • --force Force restore if site/database already exists
  • --source_sql Initiate database with a SQL file
  • --install-app Install app after installation`
• bench use [site] Sets a default site
• bench drop-site - Removes site from disk and database completely
  • --root-login
  • --root-password
• bench console - Opens a IPython console in the bench venv
• bench execute - Execute a method inside any app.
  • Eg : bench execute frappe.utils.scheduler.enqueue_scheduler_events
• bench mysql - Opens SQL Console
• bench run-tests - Run tests
  • --app App Name
  • --doctype DocType to run tests for
  • --test Specific Test
  • --module Run a particular module that has tests
  • --profile Runs a Python profiler on the test

Scheduler

• bench enable-scheduler - Enables Scheduler that will run scheduled tasks
• bench doctor - Get diagnostic info about background workers
• bench show-pending-jobs- Get pending jobs
• bench purge-jobs - Destroy all pending jobs