frappe-manager 0.19.0

A CLI tool based on Docker Compose to easily manage Frappe based projects. As of now, only suitable for development in local machines running on Mac and Linux based OS.

🚀 Frappe Manager

Simplify Your Frappe Development & Deployment Workflow

A powerful CLI tool that streamlines the entire lifecycle of Frappe applications using Docker - from development to deployment.

Quick Start • Documentation • Examples • Support

✨ Features

🔥 Easy Setup • Get a new Frappe environment running in minutes • Zero configuration needed	🐳 Docker-Based • Consistent environments across all platforms • Isolated development environments	🌐 Multi-Bench Support • Manage multiple Frappe benches from one server
👨‍💻 Development Tools • VSCode integration with debugger support • Automatic environment switching between dev/prod	🔒 SSL Management • Built-in Let's Encrypt integration • Automatic certificate renewal	🛠️ Admin Tools • Mailpit for email testing • Adminer for db management

🛠️ Requirements

• Python 3.13.+
• Docker
• VSCode (optional, for development features)

🚀 Installation

Stable Release (Recommended)

📦 For production use • Matches stable documentation

Using uv (recommended):

# Install with uv tool
uv tool install --python 3.13 frappe-manager

# Try without installing
uvx --from frappe-manager fm --help

# Upgrade to latest version
uv tool upgrade frappe-manager

Using pipx:

# Install stable version
pipx install frappe-manager 

# Upgrade to latest version
pipx upgrade frappe-manager

Development Version

🚧 For testing and contributors • Matches dev documentation

⚠️ Warning: Development builds may be unstable. Use for testing only.

Using uv:

# Install latest development version
uv tool install git+https://github.com/rtcamp/frappe-manager@develop

# Run without installing
uvx --from git+https://github.com/rtcamp/frappe-manager@develop fm --help

Using pipx:

# Install latest development version
pipx install git+https://github.com/rtcamp/frappe-manager@develop

⚡ Quick Start

Create 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 prod

That's it! Your bench is ready. Access it at http://mybench.localhost

📋 Command Reference

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> --help to see detailed options and examples for any command.

📖 Documentation

Visit our documentation site on GitHub Pages:

• https://opensource.rtcamp.com/Frappe-Manager/dev/ for detailed guides, configuration, and troubleshooting.

🤝 Support

• 🐛 Report issues
• 💬 Discussions
• 🌟 Star us on GitHub!

👏 Credits

Based on official Frappe Docker images.

📄 License

MIT License - see LICENSE file for details