A powerful CLI tool that streamlines the entire lifecycle of Frappe applications using Docker - from development to deployment.
|
• Get a new Frappe environment running in minutes • Zero configuration needed |
• Consistent environments across all platforms • Isolated development environments |
• Manage multiple Frappe benches from one server |
|
• VSCode integration with debugger support • Automatic environment switching between dev/prod |
• Built-in Let's Encrypt integration • Automatic certificate renewal |
• Mailpit for email testing • Adminer for db management |
- Python 3.13.+
- Docker
- VSCode (optional, for development features)
uv is a fast Python package installer and resolver.
# Run directly without installation (requires uv)
uvx --from frappe-manager fm create mysite
# Run latest development version without installation
uvx --from git+https://github.com/rtcamp/frappe-manager@develop fm --help
# Install with uv tool (persistent installation)
uv tool install --python 3.13 frappe-manager
# Install latest development version
uv tool install git+https://github.com/rtcamp/frappe-manager@develop
# Upgrade to latest version
uv tool upgrade frappe-manager# Install stable version
pipx install frappe-manager
# Install latest development version
pipx install git+https://github.com/rtcamp/frappe-manager@develop
# Upgrade to latest version
pipx upgrade frappe-managerCreate your first Frappe bench:
# Create a development bench (default)
fm create mybench
# Create with ERPNext
fm create mybench --apps frappe:version-16 --apps erpnext:version-16
# Create with multiple apps
fm create mybench --apps erpnext --apps hrms
# Create production bench
fm create mybench --environment prodThat's it! Your bench is ready. Access it at http://mybench.localhost
| Command | Description | Documentation |
|---|---|---|
fm code |
Open bench in vscode. | Docs: Code |
fm create |
Create a new bench with apps | Docs: Create |
fm delete |
Delete a bench and optionally its database from global-db service. | Docs: Delete |
fm info |
Show bench information and configuration | Docs: Info |
fm list |
List all benches. | Docs: List |
fm logs |
Show bench logs (server or container) | Docs: Logs |
fm migrate |
Migrate Frappe Manager to current version. | Docs: Migrate |
fm ngrok |
Create ngrok tunnel for bench | Docs: Ngrok |
fm reset |
Drop database and reinstall all apps | Docs: Reset |
fm restart |
Restart bench services (web, workers, redis, nginx) | Docs: Restart |
fm self |
Manage self | Docs: Self |
fm services |
Manage services | Docs: Services |
fm shell |
Spawn shell for the bench or execute a command. | Docs: Shell |
fm ssl |
Manage ssl | Docs: Ssl |
fm start |
Start a bench. | Docs: Start |
fm stop |
Stop a bench. | Docs: Stop |
fm update |
Update bench configuration and settings | Docs: Update |
💡 Tip: Use
fm <command> --helpto see detailed options and examples for any command.
Visit our documentation site on GitHub Pages:
- https://opensource.rtcamp.com/Frappe-Manager/ for detailed guides, configuration, and troubleshooting.
- 🐛 Report issues
- 💬 Discussions
- 🌟 Star us on GitHub!
Based on official Frappe Docker images.
MIT License - see LICENSE file for details