How rtcamp/frappe-manager works
Frappe Manager is a Docker-based CLI for creating and operating Frappe benches, with multi-bench management, development tools, global services, migrations, and SSL capabilities. The principal workflow starts with a user command, dispatches through the CLI, and manages a bench through site and Docker layers. The README documents several capabilities whose detailed implementations were not sampled; those branches are shown at their documented command boundary. Source-index references support some internal links, but not every runtime call.
Main entry points: __init__.py Command registry · services.py Global services · main.py CLI entry point · docker_client.py Docker interface
Components 19
CLI and output
- CLI entry point
frappe_manager/main.py - Command registry
frappe_manager/commands/__init__.py - Terminal output
frappe_manager/output_manager/rich_output.py
Bench lifecycle
- Bench creation
frappe_manager/commands/create.py - Bench and site
frappe_manager/site_manager/site.py - Bench services
frappe_manager/site_manager/bench_service.py - Development tools
frappe_manager/site_manager/modules/bench_devtools.py
Services and Docker
- Docker interface
frappe_manager/docker/docker_client.py - Compose configuration
frappe_manager/docker/compose_file.py - Global services
frappe_manager/services_manager/services.py - Database services
frappe_manager/services_manager/database_service_manager.py - Admin utilities
frappe_manager/site_manager/modules/bench_admin_tools.py
Operations
- Migration workflow
frappe_manager/migration_manager/migration_orchestrator.py - Migration backups
frappe_manager/migration_manager/backup_manager.py - SSL management
frappe_manager/ssl_manager/ssl_certificate_manager.py - Manager metadata
frappe_manager/metadata_manager.py - Logging
frappe_manager/logger/log.py - Ngrok tunnels
frappe_manager/ngrok.py
Other components
- CLI user
Connections 20
- CLI user → CLI entry point: runs command
README.md - CLI entry point → Command registry: dispatches
frappe_manager/main.py - CLI user → Bench creation: creates bench
README.md - Command registry → Migration workflow: registers migration
frappe_manager/commands/__init__.py - Command registry → Manager metadata: uses metadata
frappe_manager/commands/__init__.py - Command registry → Global services: uses services
frappe_manager/commands/__init__.py - Command registry → Ngrok tunnels: uses tunnels
frappe_manager/commands/__init__.py - CLI user → Bench and site: manages benches
README.md - CLI user → Development tools: opens development tools
README.md - CLI user → Admin utilities: uses admin tools
README.md - CLI user → SSL management: manages certificates
README.md - Migration workflow → Migration backups: creates backups
frappe_manager/migration_manager/migration_orchestrator.py - Bench services → Bench and site: uses bench config
frappe_manager/site_manager/bench_service.py - Bench services → Global services: starts services
frappe_manager/site_manager/bench_service.py - Global services → Database services: creates manager
frappe_manager/services_manager/services.py - Global services → Docker interface: controls containers
frappe_manager/services_manager/services.py - Docker interface → Compose configuration: reads compose
frappe_manager/docker/docker_client.py - SSL management → Docker interface: controls proxy
frappe_manager/ssl_manager/ssl_certificate_manager.py - Command registry → Terminal output: reports results
frappe_manager/commands/__init__.py - CLI entry point → Logging: configures logging
frappe_manager/main.py