Frappe Manager

bench get-app https://github.com/rtCamp/Frappe-Manager

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=rtCamp%2FFrappe-Manager)](https://frappegems.com/gems/apps/rtCamp/Frappe-Manager)

 ## ✨ 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 ### Using uv (Recommended) [uv](https://docs.astral.sh/uv/) is a fast Python package installer and resolver. ```bash # 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 ``` ### Using pipx (Alternative) ```bash # 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-manager ``` ## ⚡ Quick Start Create your first Frappe bench: ```bash # 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](https://opensource.rtcamp.com/Frappe-Manager/commands/code/) | | `fm create` | Create a new bench with apps | [Docs: Create](https://opensource.rtcamp.com/Frappe-Manager/commands/create/) | | `fm delete` | Delete a bench and optionally its database from global-db service. | [Docs: Delete](https://opensource.rtcamp.com/Frappe-Manager/commands/delete/) | | `fm info` | Show bench information and configuration | [Docs: Info](https://opensource.rtcamp.com/Frappe-Manager/commands/info/) | | `fm list` | List all benches. | [Docs: List](https://opensource.rtcamp.com/Frappe-Manager/commands/list/) | | `fm logs` | Show bench logs (server or container) | [Docs: Logs](https://opensource.rtcamp.com/Frappe-Manager/commands/logs/) | | `fm migrate` | Migrate Frappe Manager to current version. | [Docs: Migrate](https://opensource.rtcamp.com/Frappe-Manager/commands/migrate/) | | `fm ngrok` | Create ngrok tunnel for bench | [Docs: Ngrok](https://opensource.rtcamp.com/Frappe-Manager/commands/ngrok/) | | `fm reset` | Drop database and reinstall all apps | [Docs: Reset](https://opensource.rtcamp.com/Frappe-Manager/commands/reset/) | | `fm restart` | Restart bench services (web, workers, redis, nginx) | [Docs: Restart](https://opensource.rtcamp.com/Frappe-Manager/commands/restart/) | | `fm self` | Manage self | [Docs: Self](https://opensource.rtcamp.com/Frappe-Manager/commands/self/) | | `fm services` | Manage services | [Docs: Services](https://opensource.rtcamp.com/Frappe-Manager/commands/services/) | | `fm shell` | Spawn shell for the bench or execute a command. | [Docs: Shell](https://opensource.rtcamp.com/Frappe-Manager/commands/shell/) | | `fm ssl` | Manage ssl | [Docs: Ssl](https://opensource.rtcamp.com/Frappe-Manager/commands/ssl/) | | `fm start` | Start a bench. | [Docs: Start](https://opensource.rtcamp.com/Frappe-Manager/commands/start/) | | `fm stop` | Stop a bench. | [Docs: Stop](https://opensource.rtcamp.com/Frappe-Manager/commands/stop/) | | `fm update` | Update bench configuration and settings | [Docs: Update](https://opensource.rtcamp.com/Frappe-Manager/commands/update/) | > 💡 **Tip**: Use `fm --help` to see detailed options and examples for any command. ## 📖 Documentation Visit our documentation site on GitHub Pages: - https://opensource.rtcamp.com/Frappe-Manager/ for detailed guides, configuration, and troubleshooting. ## 🤝 Support - 🐛 [Report issues](https://github.com/rtCamp/Frappe-Manager/issues) - 💬 [Discussions](https://github.com/rtCamp/Frappe-Manager/discussions) - 🌟 Star us on GitHub! ## 👏 Credits Based on official [Frappe Docker](https://github.com/frappe/frappe_docker) images. ## 📄 License MIT License - see [LICENSE](LICENSE) file for details