🚀 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.
✨ 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> --helpto 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
1 maintainer
Metadata
1 maintainer
Release files for frappe-manager 0.19.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| frappe_manager-0.19.0.tar.gz | 2.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| frappe_manager-0.19.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.0 MB
Release files / frappe_manager-0.19.0.tar.gz
| Download URL | frappe_manager-0.19.0.tar.gz |
|---|---|
| Size | 2.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
129bd46e2140fb7aa4cce49c47ebc0f3c88a3d1b44c6490fa4d856389e8ccafe
|
|
BLAKE2b-256 checksum How to use checksums |
e92ed74a7da3e043a2f90185b16971a5d75a2670f3c955e5ea5f85127589c1c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / frappe_manager-0.19.0-py3-none-any.whl
| Download URL | frappe_manager-0.19.0-py3-none-any.whl |
|---|---|
| Size | 296.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b48fddaff3adde582c921b421226e88506befe1b9c56b52fa6d5836223892f9d
|
|
BLAKE2b-256 checksum How to use checksums |
7b82db8a82abc86b05cbd9b456c0e295238a9af575e10d38071a606da3b600c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
