Frappe Bench is a command-line interface (CLI) tool designed to manage multi-tenant deployments of Frappe apps and ERPNext. It handles tasks like initializing new benches, creating sites, installing apps, updating, and configuring services like Nginx and Supervisor. The current version is 5.29.1, with frequent patch and minor releases addressing bug fixes and improvements.
pip install frappe-benchVerified import paths — ran on the pinned version, not inferred.
This quickstart guides you through installing Frappe Bench, initializing a new bench environment, getting the Frappe application, creating a new site, and installing Frappe on it. Ensure you have Python 3.10 or higher installed and active before starting.
Ensure your environment uses Python 3.10 or a newer version. You can check your Python version with `python3 --version` and switch using tools like `pyenv` if needed.
Frappe Bench version 5.29.1 and later limits `setuptools` to versions below 82 to prevent this. If you encounter this with an older Bench version, try updating Bench or manually ensuring `pip install 'setuptools<82'` in your bench's environment.
After updating Bench, regenerate your Nginx configuration using `bench setup nginx`. If you have custom Nginx configurations, remove these directives to avoid Nginx startup errors.
For custom apps, ensure the `setup.py` file has a valid `name='your_app_name'` definition that can be parsed by AST, not just a regex match.