# steved3/kit_hunter architecture

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

- Interactive diagram: https://gitdiagram.com/steved3/kit_hunter
- Repository: https://github.com/steved3/kit_hunter

## Overview

Kit Hunter is a command-line phishing-kit and shell scanner. An administrator selects a scan mode and target; the tool applies the corresponding marker set, searches supported files and archives, and produces a report of matching files, tags, and (by default) matching lines. Full, quick, custom, and shell rules are distinct capabilities. The source excerpt confirms archive extraction, matching, and report creation calls, but omits much of the scan loop; other links below rely on README descriptions.

Main entry points: [`kit_hunter_2.py`](https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py) (CLI and mode selection), [`tag_files`](https://github.com/steved3/kit_hunter/tree/master/tag_files) (Full tag set), [`tag_files/quick_scan`](https://github.com/steved3/kit_hunter/tree/master/tag_files/quick_scan) (Quick tag set), [`tag_files/shell_scan`](https://github.com/steved3/kit_hunter/tree/master/tag_files/shell_scan) (Shell tag set)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_scan["Scan runtime"]
  node_cli["CLI and mode selection<br/>[kit_hunter_2.py]"]
  node_target["Scan target"]
  node_folder_reader["Folder file reader<br/>[kit_hunter_2.py]"]
  node_archive_reader["Archive reader<br/>[kit_hunter_2.py]"]
  node_matcher["Tag matcher<br/>[kit_hunter_2.py]"]
end

subgraph group_rules["Detection rules"]
  node_full_rules["Full tag set"]
  node_quick_rules["Quick tag set"]
  node_custom_rules["Custom tag files"]
  node_shell_rules["Shell tag set"]
end

subgraph group_results["Findings and reports"]
  node_report["Scan report<br/>[kit_hunter_2.py]"]
end

node_admin(("Administrator"))

node_admin -->|"selects mode"| node_cli
node_cli -->|"selects directory"| node_target
node_cli -->|"selects default rules"| node_full_rules
node_cli -->|"selects quick rules"| node_quick_rules
node_cli -->|"selects custom rules"| node_custom_rules
node_cli -->|"selects shell rules"| node_shell_rules
node_cli -->|"scans archives"| node_archive_reader
node_archive_reader -->|"passes contents"| node_matcher
node_matcher -->|"creates report"| node_report
node_report -->|"reports findings"| node_admin

click node_cli "https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py"
click node_folder_reader "https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py"
click node_archive_reader "https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py"
click node_matcher "https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py"
click node_full_rules "https://github.com/steved3/kit_hunter/tree/master/tag_files"
click node_quick_rules "https://github.com/steved3/kit_hunter/tree/master/tag_files/quick_scan"
click node_custom_rules "https://github.com/steved3/kit_hunter/tree/master/tag_files"
click node_shell_rules "https://github.com/steved3/kit_hunter/tree/master/tag_files/shell_scan"
click node_report "https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.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_target,node_folder_reader,node_archive_reader,node_matcher toneBlue
class node_full_rules,node_quick_rules,node_custom_rules,node_shell_rules toneAmber
class node_report toneMint
class node_admin toneIndigo
```

## Components

### Scan runtime

- [CLI and mode selection](https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py): `kit_hunter_2.py`
- **Scan target**
- [Folder file reader](https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py): `kit_hunter_2.py`
- [Archive reader](https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py): `kit_hunter_2.py`
- [Tag matcher](https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py): `kit_hunter_2.py`

### Detection rules

- [Full tag set](https://github.com/steved3/kit_hunter/tree/master/tag_files): `tag_files`
- [Quick tag set](https://github.com/steved3/kit_hunter/tree/master/tag_files/quick_scan): `tag_files/quick_scan`
- [Custom tag files](https://github.com/steved3/kit_hunter/tree/master/tag_files): `tag_files`
- [Shell tag set](https://github.com/steved3/kit_hunter/tree/master/tag_files/shell_scan): `tag_files/shell_scan`

### Findings and reports

- [Scan report](https://github.com/steved3/kit_hunter/blob/master/kit_hunter_2.py): `kit_hunter_2.py`

### Other components

- **Administrator**

## Connections

- Administrator → CLI and mode selection: selects mode (evidence: `Readme.md`)
- CLI and mode selection → Scan target: selects directory (evidence: `Readme.md`)
- CLI and mode selection → Full tag set: selects default rules (evidence: `kit_hunter_2.py`)
- CLI and mode selection → Quick tag set: selects quick rules (evidence: `kit_hunter_2.py`)
- CLI and mode selection → Custom tag files: selects custom rules (evidence: `kit_hunter_2.py`)
- CLI and mode selection → Shell tag set: selects shell rules (evidence: `kit_hunter_2.py`)
- CLI and mode selection → Archive reader: scans archives (evidence: `Readme.md`)
- Archive reader → Tag matcher: passes contents (evidence: `kit_hunter_2.py`)
- Tag matcher → Scan report: creates report (evidence: `kit_hunter_2.py`)
- Scan report → Administrator: reports findings (evidence: `Readme.md`)
