CLI to manage Multi-tenant deployments for Frappe apps
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Ankush Menat ca2545052d
Merge pull request #1396 from frappe/migrate_env
3 days ago
.github ci: Remove needs cond for tests job 4 months ago
bench fix: dont attempt migrating to active virtualenv 3 days ago
docs chore: remove deprecated easy install script 1 week ago
.deepsource.toml chore: add travis, deepsource (#900) 3 years ago
.editorconfig chore: add editorconfig 1 month ago
.flake8 refactor: Bench 4 months ago
.gitignore added checksum to gitignore 5 years ago
.pre-commit-config.yaml ci: fix flake8 url 1 week ago
.releaserc ci: automated release regex 4 months ago
LICENSE chore: rename license.md to license 3 years ago
README.md docs: remove easy install from docs (#1380) 1 month ago
completion.sh Autocompletion for bench (zsh and bash) 4 years ago
pyproject.toml build: Include for wheel target 4 months ago

README.md

Bench

Bench is a command-line utility that helps you to install, update, and manage multiple sites for Frappe/ERPNext applications on *nix systems for development and production.

Table of Contents

Installation

A typical bench setup provides two types of environments — Development and Production.

The setup for each of these installations can be achieved in multiple ways:

We recommend using either the Docker Installation to setup a Production Environment. For Development, you may choose either of the two methods to setup an instance.

Otherwise, if you are looking to evaluate Frappe apps without hassle of hosting, you can try them on frappecloud.com.

Containerized Installation

A Frappe/ERPNext instance can be setup and replicated easily using Docker. The officially supported Docker installation can be used to setup either of both Development and Production environments.

To setup either of the environments, you will need to clone the official docker repository:

$ git clone https://github.com/frappe/frappe_docker.git
$ cd frappe_docker

A quick setup guide for both the environments can be found below. For more details, check out the Frappe/ERPNext Docker Repository.

Manual Installation

Some might want to manually setup a bench instance locally for development. To quickly get started on installing bench the hard way, you can follow the guide on Installing Bench and the Frappe Framework.

You'll have to set up the system dependencies required for setting up a Frappe Environment. Checkout docs/installation for more information on this. If you've already set up, install bench via pip:

$ pip install frappe-bench

Basic Usage

Note: Apart from bench init, all other bench commands are expected to be run in the respective bench directory.

  • Create a new bench:

    $ bench init [bench-name]
    

    ``

  • Add a site under current bench:

    $ bench new-site [site-name]
    

    ``

    • Optional: If the database for the site does not reside on localhost or listens on a custom port, you can use the flags --db-host to set a custom host and/or --db-port to set a custom port.

      $ bench new-site [site-name] --db-host [custom-db-host-ip] --db-port [custom-db-port]
      
      
      
  • Download and add applications to bench:

    $ bench get-app [app-name] [app-link]
    

    ``

  • Install apps on a particular site

    $ bench --site [site-name] install-app [app-name]
    

    ``

  • Start bench (only for development)

    $ bench start
    

    ``

  • Show bench help:

    $ bench --help
    

    ``

For more in-depth information on commands and their usage, follow Commands and Usage. As for a consolidated list of bench commands, check out Bench Usage.

Custom Bench Commands

If you wish to extend the capabilities of bench with your own custom Frappe Application, you may follow Adding Custom Bench Commands.

Guides

For an exhaustive list of guides, check out Bench Guides.

Resources

For an exhaustive list of resources, check out Bench Resources.

Development

To contribute and develop on the bench CLI tool, clone this repo and create an editable install. In editable mode, you may get the following warning everytime you run a bench command:

WARN: bench is installed in editable mode!

This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install frappe-bench`
$ git clone https://github.com/frappe/bench ~/bench-repo
$ pip3 install -e ~/bench-repo
$ bench src
/Users/frappe/bench-repo

To clear up the editable install and switch to a stable version of bench, uninstall via pip and delete the corresponding egg file from the python path.

# Delete bench installed in editable install
$ rm -r $(find ~ -name '*.egg-info')
$ pip3 uninstall frappe-bench

# Install latest released version of bench
$ pip3 install -U frappe-bench

To confirm the switch, check the output of bench src. It should change from something like $HOME/bench-repo to /usr/local/lib/python3.6/dist-packages and stop the editable install warnings from getting triggered at every command.

Releases

Bench's version information can be accessed via bench.VERSION in the package's init.py file. Eversince the v5.0 release, we've started publishing releases on GitHub, and PyPI.

GitHub: https://github.com/frappe/bench/releases

PyPI: https://pypi.org/project/frappe-bench

From v5.3.0, we partially automated the release process using @semantic-release. Under this new pipeline, we do the following steps to make a release:

  1. Merge develop into the staging branch
  2. Merge staging into the latest stable branch, which is v5.x at this point.

This triggers a GitHub Action job that generates a bump commit, drafts and generates a GitHub release, builds a Python package and publishes it to PyPI.

The intermediate staging branch exists to mediate the bench.VERSION conflict that would arise while merging develop and stable. On develop, the version has to be manually updated (for major release changes). The version tag plays a role in deciding when checks have to be made for new Bench releases.

Note: We may want to kill the convention of separate branches for different version releases of Bench. We don't need to maintain this the way we do for Frappe & ERPNext. A single branch named stable would sustain.

License

This repository has been released under the GNU GPLv3 License.