# hellgelder/idabatchtool architecture

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

- Interactive diagram: https://gitdiagram.com/hellgelder/idabatchtool
- Repository: https://github.com/hellgelder/idabatchtool

## Overview

IDA Batch Tool analyzes executable files in batches through headless IDA, exports analysis data, and produces HTML reports; users can initiate that workflow through either the CLI or the PySide6 GUI. The product also supports directory comparison with BinDiff and Diaphora, system-function documentation reports, and APK/IPA/DMG extraction. Classifiers and documentation databases provide internal support for reporting. Relationships below are limited to the sampled source references and README claims; unsampled subsystem details are not inferred.

Main entry points: [`ida_batch_tool/classifier/categories.py`](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/categories.py) (Module categories), [`main.py`](https://github.com/hellgelder/idabatchtool/blob/master/main.py) (CLI), [`ida_batch_tool/ui/main_window.py`](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/main_window.py) (GUI window), [`ida_batch_tool/ui/pages/analysis_page.py`](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/pages/analysis_page.py) (Analysis page)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry points"]
  node_cli["CLI<br/>[main.py]"]
  node_gui["GUI window<br/>[main_window.py]"]
  node_analysis_ui["Analysis page<br/>[analysis_page.py]"]
  node_diff_ui["Diff page<br/>[difff_page.py]"]
  node_sfa_ui["Function docs page<br/>[sfa_page.py]"]
end

subgraph group_analysis["Binary analysis"]
  node_config["Configuration<br/>[loader.py]"]
  node_archive["Archive extraction<br/>[archive_handler.py]"]
  node_discovery["Executable discovery<br/>[finder.py]"]
  node_analysis_worker["Analysis worker<br/>[analysis_worker.py]"]
  node_ida_runner["IDA batch runner<br/>[runner.py]"]
  node_json_export["JSON export<br/>[export_data.py]"]
  node_html_report["HTML reports<br/>[generator.py]"]
end

subgraph group_classification["Module classification"]
  node_classifier_categories["Module categories<br/>[categories.py]"]
  node_platform_classifier["Platform classifier"]
  node_naming["Module naming<br/>[naming.py]"]
  node_windows_dict["Windows modules<br/>[windows.py]"]
  node_linux_dict["Linux modules<br/>[linux.py]"]
  node_android_dict["Android modules<br/>[android.py]"]
  node_macos_dict["Apple modules<br/>[macos.py]"]
end

subgraph group_comparison["Directory comparison"]
  node_diff_worker["Comparison worker<br/>[diff_worker.py]"]
  node_bindiff["BinDiff engine"]
  node_diaphora["Diaphora engine<br/>[diaphora.py]"]
end

subgraph group_documentation["System function reports"]
  node_sfa_report["Function documentation report<br/>[sfa_generator.py]"]
  node_function_index[("Function index")]
  node_doc_cache[("Documentation cache<br/>[sfa_doc_cache.py]")]
  node_man_db[("Man-pages database<br/>[man_pages_db.py]")]
  node_man_sync["Man-pages sync<br/>[man_pages_sync.py]"]
  node_win_sync["Windows API sync<br/>[win32_sync.py]"]
end

node_user(("User"))
node_external_docs(("Platform documentation"))

node_user -->|"runs"| node_cli
node_user -->|"opens"| node_gui
node_gui -->|"routes to"| node_analysis_ui
node_gui -->|"routes to"| node_diff_ui
node_gui -->|"routes to"| node_sfa_ui
node_cli -->|"loads"| node_config
node_cli -->|"finds files"| node_discovery
node_cli -->|"runs analysis"| node_ida_runner
node_cli -->|"generates reports"| node_html_report
node_analysis_ui -->|"extracts archives"| node_archive
node_analysis_ui -->|"finds files"| node_discovery
node_analysis_ui -->|"starts"| node_analysis_worker
node_analysis_worker -->|"runs batch"| node_ida_runner
node_analysis_worker -->|"exports data"| node_json_export
node_ida_runner -->|"loads settings"| node_config
node_html_report -->|"classifies imports"| node_platform_classifier
node_html_report -->|"groups modules"| node_classifier_categories
node_classifier_categories -->|"uses"| node_windows_dict
node_classifier_categories -->|"uses"| node_linux_dict
node_classifier_categories -->|"uses"| node_android_dict
node_classifier_categories -->|"uses"| node_macos_dict
node_classifier_categories -->|"uses"| node_naming
node_diff_ui -->|"starts comparison"| node_diff_worker
node_diff_worker -->|"runs"| node_bindiff
node_diff_worker -->|"runs"| node_diaphora
node_diff_worker -->|"generates reports"| node_html_report
node_sfa_ui -.->|"requests report"| node_sfa_report
node_sfa_report -->|"queries"| node_function_index
node_sfa_report -->|"reads cache"| node_doc_cache
node_sfa_report -->|"queries"| node_man_db
node_man_db -.->|"uses man pages"| node_external_docs
node_man_sync -.->|"syncs docs"| node_external_docs
node_win_sync -.->|"syncs API docs"| node_external_docs

click node_cli "https://github.com/hellgelder/idabatchtool/blob/master/main.py"
click node_gui "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/main_window.py"
click node_analysis_ui "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/pages/analysis_page.py"
click node_diff_ui "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/pages/difff_page.py"
click node_sfa_ui "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/pages/sfa_page.py"
click node_config "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/config/loader.py"
click node_archive "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/archive_handler.py"
click node_discovery "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/discovery/finder.py"
click node_analysis_worker "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/workers/analysis_worker.py"
click node_ida_runner "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ida/runner.py"
click node_json_export "https://github.com/hellgelder/idabatchtool/blob/master/scripts/export_data.py"
click node_classifier_categories "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/categories.py"
click node_platform_classifier "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/platform_classifier.py"
click node_naming "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/naming.py"
click node_windows_dict "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/windows.py"
click node_linux_dict "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/linux.py"
click node_android_dict "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/android.py"
click node_macos_dict "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/macos.py"
click node_html_report "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/reporting/generator.py"
click node_diff_worker "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/workers/diff_worker.py"
click node_diaphora "https://github.com/hellgelder/idabatchtool/blob/master/scripts/diaphora/diaphora.py"
click node_sfa_report "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/reporting/sfa_generator.py"
click node_function_index "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/sfa_function_index.py"
click node_doc_cache "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/sfa_doc_cache.py"
click node_man_db "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/man_pages_db.py"
click node_man_sync "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/man_pages_sync.py"
click node_win_sync "https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/win32_sync.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_gui,node_analysis_ui,node_diff_ui,node_sfa_ui,node_user toneBlue
class node_config,node_archive,node_discovery,node_analysis_worker,node_ida_runner,node_json_export,node_html_report toneAmber
class node_classifier_categories,node_platform_classifier,node_naming,node_windows_dict,node_linux_dict,node_android_dict,node_macos_dict toneMint
class node_diff_worker,node_bindiff,node_diaphora toneRose
class node_sfa_report,node_function_index,node_doc_cache,node_man_db,node_man_sync,node_win_sync,node_external_docs toneIndigo
```

## Components

### User entry points

- [CLI](https://github.com/hellgelder/idabatchtool/blob/master/main.py): `main.py`
- [GUI window](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/main_window.py): `ida_batch_tool/ui/main_window.py`
- [Analysis page](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/pages/analysis_page.py): `ida_batch_tool/ui/pages/analysis_page.py`
- [Diff page](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/pages/difff_page.py): `ida_batch_tool/ui/pages/difff_page.py`
- [Function docs page](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/pages/sfa_page.py): `ida_batch_tool/ui/pages/sfa_page.py`

### Binary analysis

- [Configuration](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/config/loader.py): `ida_batch_tool/config/loader.py`
- [Archive extraction](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/archive_handler.py): `ida_batch_tool/archive_handler.py`
- [Executable discovery](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/discovery/finder.py): `ida_batch_tool/discovery/finder.py`
- [Analysis worker](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/workers/analysis_worker.py): `ida_batch_tool/ui/workers/analysis_worker.py`
- [IDA batch runner](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ida/runner.py): `ida_batch_tool/ida/runner.py`
- [JSON export](https://github.com/hellgelder/idabatchtool/blob/master/scripts/export_data.py): `scripts/export_data.py`
- [HTML reports](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/reporting/generator.py): `ida_batch_tool/reporting/generator.py`

### Module classification

- [Module categories](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/categories.py): `ida_batch_tool/classifier/categories.py`
- [Platform classifier](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/platform_classifier.py): `ida_batch_tool/classifier/platform_classifier.py`
- [Module naming](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/naming.py): `ida_batch_tool/classifier/naming.py`
- [Windows modules](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/windows.py): `ida_batch_tool/classifier/windows.py`
- [Linux modules](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/linux.py): `ida_batch_tool/classifier/linux.py`
- [Android modules](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/android.py): `ida_batch_tool/classifier/android.py`
- [Apple modules](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/classifier/macos.py): `ida_batch_tool/classifier/macos.py`

### Directory comparison

- [Comparison worker](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/ui/workers/diff_worker.py): `ida_batch_tool/ui/workers/diff_worker.py`
- **BinDiff engine**
- [Diaphora engine](https://github.com/hellgelder/idabatchtool/blob/master/scripts/diaphora/diaphora.py): `scripts/diaphora/diaphora.py`

### System function reports

- [Function documentation report](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/reporting/sfa_generator.py): `ida_batch_tool/reporting/sfa_generator.py`
- [Function index](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/sfa_function_index.py): `ida_batch_tool/database/sfa_function_index.py`
- [Documentation cache](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/sfa_doc_cache.py): `ida_batch_tool/database/sfa_doc_cache.py`
- [Man-pages database](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/man_pages_db.py): `ida_batch_tool/database/man_pages_db.py`
- [Man-pages sync](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/man_pages_sync.py): `ida_batch_tool/database/man_pages_sync.py`
- [Windows API sync](https://github.com/hellgelder/idabatchtool/blob/master/ida_batch_tool/database/win32_sync.py): `ida_batch_tool/database/win32_sync.py`

### Other components

- **User**
- **Platform documentation**

## Connections

- User → CLI: runs (evidence: `main.py`)
- User → GUI window: opens
- GUI window → Analysis page: routes to (evidence: `ida_batch_tool/ui/main_window.py`)
- GUI window → Diff page: routes to (evidence: `ida_batch_tool/ui/main_window.py`)
- GUI window → Function docs page: routes to (evidence: `ida_batch_tool/ui/main_window.py`)
- CLI → Configuration: loads (evidence: `main.py`)
- CLI → Executable discovery: finds files (evidence: `main.py`)
- CLI → IDA batch runner: runs analysis (evidence: `main.py`)
- CLI → HTML reports: generates reports (evidence: `main.py`)
- Analysis page → Archive extraction: extracts archives (evidence: `ida_batch_tool/ui/pages/analysis_page.py`)
- Analysis page → Executable discovery: finds files (evidence: `ida_batch_tool/ui/pages/analysis_page.py`)
- Analysis page → Analysis worker: starts (evidence: `ida_batch_tool/ui/pages/analysis_page.py`)
- Analysis worker → IDA batch runner: runs batch (evidence: `ida_batch_tool/ui/workers/analysis_worker.py`)
- Analysis worker → JSON export: exports data (evidence: `ida_batch_tool/ui/workers/analysis_worker.py`)
- IDA batch runner → Configuration: loads settings (evidence: `ida_batch_tool/ida/runner.py`)
- HTML reports → Platform classifier: classifies imports (evidence: `ida_batch_tool/reporting/generator.py`)
- HTML reports → Module categories: groups modules (evidence: `ida_batch_tool/reporting/generator.py`)
- Module categories → Windows modules: uses (evidence: `ida_batch_tool/classifier/categories.py`)
- Module categories → Linux modules: uses (evidence: `ida_batch_tool/classifier/categories.py`)
- Module categories → Android modules: uses (evidence: `ida_batch_tool/classifier/categories.py`)
- Module categories → Apple modules: uses (evidence: `ida_batch_tool/classifier/categories.py`)
- Module categories → Module naming: uses (evidence: `ida_batch_tool/classifier/categories.py`)
- Diff page → Comparison worker: starts comparison (evidence: `ida_batch_tool/ui/pages/difff_page.py`)
- Comparison worker → BinDiff engine: runs (evidence: `README.md`)
- Comparison worker → Diaphora engine: runs (evidence: `README.md`)
- Comparison worker → HTML reports: generates reports (evidence: `ida_batch_tool/ui/workers/diff_worker.py`)
- Function docs page → Function documentation report: requests report
- Function documentation report → Function index: queries (evidence: `ida_batch_tool/reporting/sfa_generator.py`)
- Function documentation report → Documentation cache: reads cache (evidence: `ida_batch_tool/reporting/sfa_generator.py`)
- Function documentation report → Man-pages database: queries (evidence: `ida_batch_tool/reporting/sfa_generator.py`)
- Man-pages database → Platform documentation: uses man pages
- Man-pages sync → Platform documentation: syncs docs
- Windows API sync → Platform documentation: syncs API docs
