# diogodealencar-del/panorama-cleanup architecture

> Architecture diagram of the GitHub repository diogodealencar-del/panorama-cleanup, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/diogodealencar-del/panorama-cleanup
- Repository: https://github.com/diogodealencar-del/panorama-cleanup

## Overview

Panorama Configuration Analyzer is a local tool for auditing and safely cleaning Palo Alto Panorama XML backups. Users run independent inventory, analysis, planning, apply, and validation commands; each consumes the supplied backup and any explicitly selected prior-run artifacts. Planning proposes Shared centralization and cleanup, while apply changes only an XML copy and validation checks the result. The README also documents generated PAN-OS CLI/XML API commands and Claude skills; the tool itself does not connect to Panorama or commit/push changes. Relationships below follow the sampled modules and README; several implementation details are unsampled.

Main entry points: [`panorama_cleanup/cli.py`](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/cli.py) (CLI modes), [`panorama_cleanup/analysis.py`](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/analysis.py) (Analysis orchestration), [`panorama_cleanup/inventory.py`](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/inventory.py) (Object inventory), [`panorama_cleanup/xml_reader.py`](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/xml_reader.py) (XML reader)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ingest["Input and runs"]
  node_cli["CLI modes<br/>[cli.py]"]
  node_runctx["Run context<br/>[run_context.py]"]
  node_xml["XML reader<br/>[xml_reader.py]"]
end

subgraph group_audit["Inventory and analysis"]
  node_inventory["Object inventory<br/>[inventory.py]"]
  node_analysis["Analysis orchestration<br/>[analysis.py]"]
  node_dependencies["Dependency graph"]
  node_usage["Usage classification<br/>[unused_objects.py]"]
  node_duplicates["Duplicate analysis"]
end

subgraph group_plan["Planning and apply"]
  node_planner["Change planner<br/>[planner.py]"]
  node_effective["Effective model<br/>[effective_model.py]"]
  node_converter["Shared converter"]
  node_cleanup["Unused cleanup<br/>[cleanup.py]"]
end

subgraph group_outputs["Validation and outputs"]
  node_validation["Final validation"]
  node_policy["Policy comparison"]
  node_reports["Reports"]
  node_cli_commands["PAN-OS commands<br/>[generate_cli.py]"]
end

node_operator(("Operator"))
node_panorama["Panorama"]
node_skill["Claude skill<br/>[run.py]"]

node_operator -->|"runs mode"| node_cli
node_cli -->|"creates run"| node_runctx
node_cli -->|"reads backup"| node_xml
node_xml -->|"provides metadata"| node_inventory
node_cli -->|"builds inventory"| node_inventory
node_analysis -->|"builds inventory"| node_inventory
node_analysis -->|"analyzes references"| node_dependencies
node_analysis -->|"classifies usage"| node_usage
node_analysis -->|"analyzes duplicates"| node_duplicates
node_cli -->|"runs analysis"| node_analysis
node_cli -->|"plans changes"| node_planner
node_planner -->|"checks equivalence"| node_effective
node_cli -->|"applies plan"| node_converter
node_cli -->|"applies cleanup"| node_cleanup
node_cli -->|"validates result"| node_validation
node_validation -->|"compares policies"| node_policy
node_cli -->|"writes reports"| node_reports
node_cli -->|"generates commands"| node_cli_commands
node_cli_commands -.->|"commands for"| node_panorama
node_operator -.->|"requests workflow"| node_skill
node_skill -.->|"invokes modes"| node_cli

click node_cli "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/cli.py"
click node_runctx "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/run_context.py"
click node_xml "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/xml_reader.py"
click node_inventory "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/inventory.py"
click node_analysis "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/analysis.py"
click node_dependencies "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/dependency_analyzer.py"
click node_usage "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/unused_objects.py"
click node_duplicates "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/duplicate_analyzer.py"
click node_planner "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/planner.py"
click node_effective "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/effective_model.py"
click node_converter "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/shared_converter.py"
click node_cleanup "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/cleanup.py"
click node_validation "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/final_validation.py"
click node_policy "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/policy_comparator.py"
click node_reports "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/report_generator.py"
click node_cli_commands "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/generate_cli.py"
click node_skill "https://github.com/diogodealencar-del/panorama-cleanup/blob/main/skill/run.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_runctx,node_xml toneBlue
class node_inventory,node_analysis,node_dependencies,node_usage,node_duplicates toneAmber
class node_planner,node_effective,node_converter,node_cleanup toneMint
class node_validation,node_policy,node_reports,node_cli_commands toneRose
class node_operator,node_panorama toneIndigo
class node_skill toneTeal
```

## Components

### Input and runs

- [CLI modes](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/cli.py): `panorama_cleanup/cli.py`
- [Run context](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/run_context.py): `panorama_cleanup/run_context.py`
- [XML reader](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/xml_reader.py): `panorama_cleanup/xml_reader.py`

### Inventory and analysis

- [Object inventory](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/inventory.py): `panorama_cleanup/inventory.py`
- [Analysis orchestration](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/analysis.py): `panorama_cleanup/analysis.py`
- [Dependency graph](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/dependency_analyzer.py): `panorama_cleanup/dependency_analyzer.py`
- [Usage classification](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/unused_objects.py): `panorama_cleanup/unused_objects.py`
- [Duplicate analysis](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/duplicate_analyzer.py): `panorama_cleanup/duplicate_analyzer.py`

### Planning and apply

- [Change planner](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/planner.py): `panorama_cleanup/planner.py`
- [Effective model](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/effective_model.py): `panorama_cleanup/effective_model.py`
- [Shared converter](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/shared_converter.py): `panorama_cleanup/shared_converter.py`
- [Unused cleanup](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/cleanup.py): `panorama_cleanup/cleanup.py`

### Validation and outputs

- [Final validation](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/final_validation.py): `panorama_cleanup/final_validation.py`
- [Policy comparison](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/policy_comparator.py): `panorama_cleanup/policy_comparator.py`
- [Reports](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/report_generator.py): `panorama_cleanup/report_generator.py`
- [PAN-OS commands](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/panorama_cleanup/generate_cli.py): `panorama_cleanup/generate_cli.py`

### Other components

- **Operator**
- **Panorama**
- [Claude skill](https://github.com/diogodealencar-del/panorama-cleanup/blob/main/skill/run.py): `skill/run.py`

## Connections

- Operator → CLI modes: runs mode (evidence: `README.md`)
- CLI modes → Run context: creates run (evidence: `panorama_cleanup/cli.py`)
- CLI modes → XML reader: reads backup (evidence: `panorama_cleanup/cli.py`)
- XML reader → Object inventory: provides metadata (evidence: `panorama_cleanup/inventory.py`)
- CLI modes → Object inventory: builds inventory (evidence: `panorama_cleanup/cli.py`)
- Analysis orchestration → Object inventory: builds inventory (evidence: `panorama_cleanup/analysis.py`)
- Analysis orchestration → Dependency graph: analyzes references (evidence: `panorama_cleanup/analysis.py`)
- Analysis orchestration → Usage classification: classifies usage (evidence: `panorama_cleanup/analysis.py`)
- Analysis orchestration → Duplicate analysis: analyzes duplicates (evidence: `panorama_cleanup/analysis.py`)
- CLI modes → Analysis orchestration: runs analysis (evidence: `panorama_cleanup/cli.py`)
- CLI modes → Change planner: plans changes (evidence: `panorama_cleanup/cli.py`)
- Change planner → Effective model: checks equivalence (evidence: `panorama_cleanup/planner.py`)
- CLI modes → Shared converter: applies plan (evidence: `panorama_cleanup/cli.py`)
- CLI modes → Unused cleanup: applies cleanup (evidence: `panorama_cleanup/cli.py`)
- CLI modes → Final validation: validates result (evidence: `panorama_cleanup/cli.py`)
- Final validation → Policy comparison: compares policies (evidence: `panorama_cleanup/final_validation.py`)
- CLI modes → Reports: writes reports (evidence: `panorama_cleanup/cli.py`)
- CLI modes → PAN-OS commands: generates commands (evidence: `README.md`)
- PAN-OS commands → Panorama: commands for (evidence: `README.md`)
- Operator → Claude skill: requests workflow (evidence: `README.md`)
- Claude skill → CLI modes: invokes modes (evidence: `README.md`)
