Home

Frappe-Manager (frappe-manager) is a tool that simplifies the process of creating and managing development environments for Frappe based apps.

Important

This tool is intended for use with a non-root user.

Important

If you update non-editable packages in Frappe's Python environment, use the fm restart <benchname> command to restart the related container services, if not you may encounter ModuleNotFoundError: No module named 'module_name' error in logs.

Operation Insights

• If you have created site named example then it's url will be http://example.localhost.
• If you've created a site named example.com but haven't set up a corresponding DNS entry, accessing the site will require adding a mapping to /etc/hosts.
• frappe-manager overrides the bench restart subcommand of bench. It adds functionality to restart the bench development server within bench environment.

frappe-manager provides these commands as main interface to interact with this project via fm cli

fm

Frappe-Manager for creating frappe development environments.

Usage:

$ fm [OPTIONS] COMMAND [ARGS]...

Options:

• -v, --verbose: Enable verbose output.
• -V, --version: Show Version.
• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands:

• create: Create a new bench.
• delete: Delete a bench.
• code: Open bench in vscode.
• list: Lists all of the available benches.
• info: Shows information about given bench.
• logs: Show frappe server logs or container logs for a given bench.
• self: Perform operations related to the fm itself.
• services: Handle global services.
• shell: Spawn shell for the give bench.
• ssl: Perform operations related to ssl.
• start: Start a bench.
• stop: Stop a bench.
• update: Update bench.

Have questions? Check out our FAQ section for quick answers.