to select ↑↓ to navigate
Developer Guides

Developer Guides

Open in ChatGPT
Ask ChatGPT about this page
Open in Claude
Ask Claude about this page

Using bench CLI

Starting the bench:

bench start

Getting Frappe's official apps from GitHub:

bench get-app --branch version-16 erpnext

Getting third party custom app by specifying the repo url:

bench get-app https://github.com/account/repo

Getting specific branch:

bench get-app --branch version-15 https://github.com/account/repo

Show all apps and versions in bench:

bench version

Creating a site

bench new-site my-site

Set default site:

bench use my-site

Install an app to default site:

bench install-app erpnext

Migrate default site database:

bench migrate

Show all installed apps of default site:

bench list-apps

Unistall an app from default site:

bench uninstall-app erpnext

Browse default site from browser:

http://127.0.0.1:8000

Backup a site:

bench backup

Restore a site database:

bench store path/to/backup-database-file.sql.gz

Deleting a site:

bench drop-site my-site

Stopping and restarting the bench:

Press CTRL+C

and then:

bench start

Enable Developer Mode:

bench set-config developer_mode 1

Creating a new Custom App in Bench:

bench new-app my_app

Removing App from Bench:

bench remove-app my_app

Update installed apps in bench:

bench update --reset
Last updated 2 months ago
Was this helpful?
Thanks!