Skip to content

Instantly share code, notes, and snippets.

@MaxMorais
Created August 9, 2015 20:54
Show Gist options
  • Save MaxMorais/b2b0ddfc8039cbabfe6d to your computer and use it in GitHub Desktop.
Save MaxMorais/b2b0ddfc8039cbabfe6d to your computer and use it in GitHub Desktop.
Usage: [OPTIONS] COMMAND [ARGS]...
Bench manager for Frappe
Options:
--help Show this message and exit.
Commands:
backup backup site
backup-all-sites backup all sites
config change bench configuration
download-translations Download latest translations
get-app clone an app from the internet and set it up...
init Create a new bench
migrate-3to4 Migrate from ERPNext v3.x
new-app start a new app
new-site Create a new site in the bench
patch
prime-wheel-cache Update wheel cache
release Release app (internal to the Frappe team)
restart Restart supervisor processes
retry-upgrade
set-default-site Set default site for bench
set-mariadb-host Set MariaDB host for bench
set-nginx-port Set nginx port for site
set-ssl-certificate Set ssl certificate path for site
set-ssl-key Set ssl certificate private key path for site
set-url-root Set url root for site
setup Setup bench
shell
start Start Frappe development processes
switch-to-develop Switch frappe and erpnext to develop branch
switch-to-master Switch frappe and erpnext to master branch
switch-to-v4 Switch frappe and erpnext to v4 branch
update Update bench
Framework commands:
add-system-manager Add a new system manager to a site
backup Backup
build Minify + concatenate JS and CSS files, build...
build-message-files Build message files for translation
build-website Sync statics and clear cache
celery Run a celery command
clear-cache Clear cache, doctype cache and defaults
clear-website-cache Clear website cache
console Start ipython console for a site
destroy-all-sessions Clear sessions of all users (logs them out)
disable-scheduler Disable scheduler
doctor Get untranslated strings for lang.
drop-site
dump-queue-status Dump detailed diagnostic infomation for task...
enable-scheduler Enable scheduler
execute execute a function
export-csv Dump DocType as csv
export-doc Export a single document to csv
export-fixtures export fixtures
export-json Export doclist as json to the given path, use...
get-untranslated Get untranslated strings for language
import-doc Import (insert/update) doclist.
install-app Install a new app to site
make-app
migrate Run patches, sync schema and rebuild...
mysql Start Mariadb console for a site
new-site Install a new site
purge-all-tasks Purge any pending periodic tasks of 'all'...
reinstall Reinstall site ie.
reload-doc Reload schema for a DocType
remove-from-installed-apps
request Run a request as an admin
reset-perms Reset permissions for all doctypes
restore Restore site database from an sql file
run-patch Run a particular patch
run-tests Run tests
serve Start development web server
set-admin-password Set Administrator password for a site
setup-docs Setup docs in target folder of target app
sync-www Sync files from static pages from www...
trigger-scheduler-event Trigger a scheduler event
update-translations Update translated strings
use
watch Watch and concatenate JS and CSS files as and...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment