# rtcamp/frappe-manager architecture

> Architecture diagram of the GitHub repository rtcamp/frappe-manager, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rtcamp/frappe-manager
- Repository: https://github.com/rtcamp/frappe-manager

## Overview

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: [`frappe_manager/commands/__init__.py`](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/commands/__init__.py) (Command registry), [`frappe_manager/services_manager/services.py`](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/services_manager/services.py) (Global services), [`frappe_manager/main.py`](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/main.py) (CLI entry point), [`frappe_manager/docker/docker_client.py`](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/docker/docker_client.py) (Docker interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI and output"]
  node_cli["CLI entry point<br/>[main.py]"]
  node_commands["Command registry<br/>[__init__.py]"]
  node_output["Terminal output<br/>[rich_output.py]"]
end

subgraph group_bench["Bench lifecycle"]
  node_create["Bench creation<br/>[create.py]"]
  node_site["Bench and site<br/>[site.py]"]
  node_bench_service["Bench services<br/>[bench_service.py]"]
  node_development["Development tools<br/>[bench_devtools.py]"]
end

subgraph group_services["Services and Docker"]
  node_docker["Docker interface<br/>[docker_client.py]"]
  node_compose["Compose configuration<br/>[compose_file.py]"]
  node_global_services["Global services<br/>[services.py]"]
  node_database["Database services"]
  node_admin["Admin utilities"]
end

subgraph group_operations["Operations"]
  node_migration["Migration workflow"]
  node_backup["Migration backups<br/>[backup_manager.py]"]
  node_ssl["SSL management"]
  node_metadata["Manager metadata"]
  node_logs["Logging<br/>[log.py]"]
  node_ngrok["Ngrok tunnels<br/>[ngrok.py]"]
end

node_user(("CLI user"))

node_user -->|"runs command"| node_cli
node_cli -->|"dispatches"| node_commands
node_user -->|"creates bench"| node_create
node_commands -->|"registers migration"| node_migration
node_commands -->|"uses metadata"| node_metadata
node_commands -->|"uses services"| node_global_services
node_commands -->|"uses tunnels"| node_ngrok
node_user -->|"manages benches"| node_site
node_user -->|"opens development tools"| node_development
node_user -->|"uses admin tools"| node_admin
node_user -->|"manages certificates"| node_ssl
node_migration -->|"creates backups"| node_backup
node_bench_service -->|"uses bench config"| node_site
node_bench_service -->|"starts services"| node_global_services
node_global_services -->|"creates manager"| node_database
node_global_services -->|"controls containers"| node_docker
node_docker -->|"reads compose"| node_compose
node_ssl -->|"controls proxy"| node_docker
node_commands -->|"reports results"| node_output
node_cli -->|"configures logging"| node_logs

click node_cli "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/main.py"
click node_commands "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/commands/__init__.py"
click node_output "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/output_manager/rich_output.py"
click node_create "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/commands/create.py"
click node_site "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/site.py"
click node_bench_service "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/bench_service.py"
click node_development "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/modules/bench_devtools.py"
click node_docker "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/docker/docker_client.py"
click node_compose "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/docker/compose_file.py"
click node_global_services "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/services_manager/services.py"
click node_database "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/services_manager/database_service_manager.py"
click node_admin "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/modules/bench_admin_tools.py"
click node_migration "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/migration_manager/migration_orchestrator.py"
click node_backup "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/migration_manager/backup_manager.py"
click node_ssl "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/ssl_manager/ssl_certificate_manager.py"
click node_metadata "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/metadata_manager.py"
click node_logs "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/logger/log.py"
click node_ngrok "https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/ngrok.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_commands,node_output,node_user toneBlue
class node_create,node_site,node_bench_service,node_development toneAmber
class node_docker,node_compose,node_global_services,node_database,node_admin toneMint
class node_migration,node_backup,node_ssl,node_metadata,node_logs,node_ngrok toneRose
```

## Components

### CLI and output

- [CLI entry point](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/main.py): `frappe_manager/main.py`
- [Command registry](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/commands/__init__.py): `frappe_manager/commands/__init__.py`
- [Terminal output](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/output_manager/rich_output.py): `frappe_manager/output_manager/rich_output.py`

### Bench lifecycle

- [Bench creation](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/commands/create.py): `frappe_manager/commands/create.py`
- [Bench and site](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/site.py): `frappe_manager/site_manager/site.py`
- [Bench services](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/bench_service.py): `frappe_manager/site_manager/bench_service.py`
- [Development tools](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/modules/bench_devtools.py): `frappe_manager/site_manager/modules/bench_devtools.py`

### Services and Docker

- [Docker interface](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/docker/docker_client.py): `frappe_manager/docker/docker_client.py`
- [Compose configuration](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/docker/compose_file.py): `frappe_manager/docker/compose_file.py`
- [Global services](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/services_manager/services.py): `frappe_manager/services_manager/services.py`
- [Database services](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/services_manager/database_service_manager.py): `frappe_manager/services_manager/database_service_manager.py`
- [Admin utilities](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/site_manager/modules/bench_admin_tools.py): `frappe_manager/site_manager/modules/bench_admin_tools.py`

### Operations

- [Migration workflow](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/migration_manager/migration_orchestrator.py): `frappe_manager/migration_manager/migration_orchestrator.py`
- [Migration backups](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/migration_manager/backup_manager.py): `frappe_manager/migration_manager/backup_manager.py`
- [SSL management](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/ssl_manager/ssl_certificate_manager.py): `frappe_manager/ssl_manager/ssl_certificate_manager.py`
- [Manager metadata](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/metadata_manager.py): `frappe_manager/metadata_manager.py`
- [Logging](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/logger/log.py): `frappe_manager/logger/log.py`
- [Ngrok tunnels](https://github.com/rtcamp/frappe-manager/blob/develop/frappe_manager/ngrok.py): `frappe_manager/ngrok.py`

### Other components

- **CLI user**

## Connections

- CLI user → CLI entry point: runs command (evidence: `README.md`)
- CLI entry point → Command registry: dispatches (evidence: `frappe_manager/main.py`)
- CLI user → Bench creation: creates bench (evidence: `README.md`)
- Command registry → Migration workflow: registers migration (evidence: `frappe_manager/commands/__init__.py`)
- Command registry → Manager metadata: uses metadata (evidence: `frappe_manager/commands/__init__.py`)
- Command registry → Global services: uses services (evidence: `frappe_manager/commands/__init__.py`)
- Command registry → Ngrok tunnels: uses tunnels (evidence: `frappe_manager/commands/__init__.py`)
- CLI user → Bench and site: manages benches (evidence: `README.md`)
- CLI user → Development tools: opens development tools (evidence: `README.md`)
- CLI user → Admin utilities: uses admin tools (evidence: `README.md`)
- CLI user → SSL management: manages certificates (evidence: `README.md`)
- Migration workflow → Migration backups: creates backups (evidence: `frappe_manager/migration_manager/migration_orchestrator.py`)
- Bench services → Bench and site: uses bench config (evidence: `frappe_manager/site_manager/bench_service.py`)
- Bench services → Global services: starts services (evidence: `frappe_manager/site_manager/bench_service.py`)
- Global services → Database services: creates manager (evidence: `frappe_manager/services_manager/services.py`)
- Global services → Docker interface: controls containers (evidence: `frappe_manager/services_manager/services.py`)
- Docker interface → Compose configuration: reads compose (evidence: `frappe_manager/docker/docker_client.py`)
- SSL management → Docker interface: controls proxy (evidence: `frappe_manager/ssl_manager/ssl_certificate_manager.py`)
- Command registry → Terminal output: reports results (evidence: `frappe_manager/commands/__init__.py`)
- CLI entry point → Logging: configures logging (evidence: `frappe_manager/main.py`)
