Skip to content
Xieyt edited this page Dec 4, 2023 · 29 revisions

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

  • If you have created site named example then it's url will be http://example.localhost.
  • Default Branch: In the fm create <sitename> command, the default --frappe-branch is set to version-15, and the default branch name for apps, specified with the --apps flag, is set to the default branch on GitHub.

Operation Insights

  • frappe-manager overrides the bench restart subcommand of bench provided by Frappe. It adds functionality to restart the bench development server within bench environment.
  • Site Management: Only one site can be active at a time in a single machine. When the fm start <sitename> command is given, all other sites are stopped, and the specified site is started.

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

fm

CLI tool for creating Frappe development environments.

Usage:

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

Options:

  • -v, --verbose: Enable verbose output.
  • --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 site.
  • delete: Delete a site.
  • code: Open site in vscode.
  • list: Lists all of the available sites.
  • info: Shows information about given site.
  • logs: Show logs for the given site.
  • shell: Open shell for the give site.
  • start: Start a site.
  • stop: Stop a site.

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

Clone this wiki locally