Home

Frappe-Manager (frappe-manager) is a tool designed to simplify the creation and management of development environments for Frappe-based applications.

Operation Insights

• This tool is intended for use with a non-root user.
• If you create a site named example, its URL will be http://example.localhost.
• If you create a site named example.com but haven't set up a corresponding DNS entry, you will need to add a mapping to /etc/hosts to access the site.
• If you update non-editable packages in Frappe's Python environment, use the bench restart/fmx restart in fm shell <benchname> command to restart the related container services, if not you may encounter ModuleNotFoundError: No module named 'module_name' error in logs.
• frappe-manager overrides the bench restart subcommand of bench, adding functionality to restart the bench development server within the bench environment.

frappe-manager package provides the following commands as the main interface for interacting with your development environments.

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:

• code: Open bench in vscode.
• create: Create a new bench with apps
• delete: Delete a bench and optionally its database from global-db service.
• info: Show bench information and configuration
• list: List all benches.
• logs: Show bench logs (server or container)
• migrate: Migrate Frappe Manager to current version.
• ngrok: Create ngrok tunnel for bench
• reset: Drop database and reinstall all apps
• restart: Restart bench services (web, workers, redis, nginx)
• shell: Spawn shell for the bench or execute a command.
• start: Start a bench.
• stop: Stop a bench.
• update: Update bench configuration and settings
• self: Self commands.
• services: Services commands.
• ssl: Ssl commands.

fmx CLI (Service Management Inside the Container)

Interact with supervisord instances managed by Frappe Manager.

Provides commands to stop, start, restart, and check the status of background services (like Frappe, Workers, Scheduler) running within the Frappe Manager Docker environment.

To access it, use:

fm shell <benchname>

fmx --help (inside container)

Usage:

$ fmx [OPTIONS] COMMAND [ARGS]...

Commands:

• restart: Restart Frappe services safely (with options for worker coordination and migrations)
• start: Start services or specific processes.
• status: Check the status of services.
• stop: Stop services or specific processes.

Note:

• Once inside the container shell, you can use fmx to manage internal frappe services
• The fmx CLI is only available only inside the container, basically after using fm shell <benchname>.

For more details on safe restarts and migrations, see Workers.md.

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