# soonover/weknown architecture

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

- Interactive diagram: https://gitdiagram.com/soonover/weknown
- Repository: https://github.com/soonover/weknown

## Overview

WeKnown is a CLI domain-scanning tool that gathers DNS, subdomain, origin-IP, and web-service intelligence and presents a report. The main workflow is CLI targets and options → bootstrap/configuration → Scanner → formatted output. Scanner delegates DNS work to DnsResolver and network requests to HttpClient; DNS results are cached. README capabilities such as deep/fast scans, multiple output formats, and API-key integrations are represented at the Scanner or CLI level where their detailed implementation was not fully sampled. Connections reflect shown calls or README statements; unsampled scanner stages are not expanded into guessed internal pipelines.

Main entry points: [`weknown.php`](https://github.com/soonover/weknown/blob/main/weknown.php) (CLI Entry), [`src/WeKnown/Scanner.php`](https://github.com/soonover/weknown/blob/main/src/WeKnown/Scanner.php) (Domain Scanner), [`src/WeKnown/HttpClient.php`](https://github.com/soonover/weknown/blob/main/src/WeKnown/HttpClient.php) (HTTP Client), [`src/WeKnown/DnsResolver.php`](https://github.com/soonover/weknown/blob/main/src/WeKnown/DnsResolver.php) (DNS Resolver)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and Configuration"]
  node_cli["CLI Entry<br/>[weknown.php]"]
  node_settings["Settings<br/>[Config.php]"]
  node_configfile["Config File<br/>[config.json]"]
end

subgraph group_scan["Domain Scanning"]
  node_scanner["Domain Scanner<br/>[Scanner.php]"]
  node_dns["DNS Resolver<br/>[DnsResolver.php]"]
  node_formatter["Report Formatter"]
end

subgraph group_runtime["Runtime Services"]
  node_http["HTTP Client<br/>[HttpClient.php]"]
  node_cache[("DNS Cache<br/>[Cache.php]")]
  node_logger["Logger<br/>[Logger.php]"]
end

subgraph group_outside["External Systems"]
  node_target(("Target Domains"))
  node_intel{{"Discovery Sources"}}
  node_webservices{{"Web and API Services"}}
end

node_user(("CLI User"))
node_terminal(("Terminal Output"))

node_user -->|"runs scan"| node_cli
node_target -->|"provides targets"| node_cli
node_cli -->|"loads settings"| node_settings
node_configfile -->|"configures"| node_settings
node_cli -->|"runs scan"| node_scanner
node_cli -->|"formats help"| node_formatter
node_cli -->|"initializes"| node_http
node_cli -->|"initializes"| node_dns
node_cli -->|"initializes"| node_cache
node_cli -->|"initializes"| node_logger
node_scanner -->|"resolves subdomains"| node_dns
node_scanner -->|"requests intelligence"| node_http
node_scanner -->|"queries discovery sources"| node_intel
node_scanner -->|"queries web services"| node_webservices
node_dns -->|"reads and writes"| node_cache
node_http -->|"reads options"| node_settings
node_http -->|"logs requests"| node_logger
node_cli -->|"formats results"| node_formatter
node_formatter -->|"prints report"| node_terminal

click node_cli "https://github.com/soonover/weknown/blob/main/weknown.php"
click node_settings "https://github.com/soonover/weknown/blob/main/src/WeKnown/Config.php"
click node_configfile "https://github.com/soonover/weknown/blob/main/config.json"
click node_scanner "https://github.com/soonover/weknown/blob/main/src/WeKnown/Scanner.php"
click node_dns "https://github.com/soonover/weknown/blob/main/src/WeKnown/DnsResolver.php"
click node_formatter "https://github.com/soonover/weknown/blob/main/src/WeKnown/OutputFormatter.php"
click node_http "https://github.com/soonover/weknown/blob/main/src/WeKnown/HttpClient.php"
click node_cache "https://github.com/soonover/weknown/blob/main/src/WeKnown/Cache.php"
click node_logger "https://github.com/soonover/weknown/blob/main/src/WeKnown/Logger.php"

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_settings,node_configfile,node_user toneBlue
class node_scanner,node_dns,node_formatter toneAmber
class node_http,node_cache,node_logger toneMint
class node_target,node_intel,node_webservices toneRose
class node_terminal toneIndigo
```

## Components

### CLI and Configuration

- [CLI Entry](https://github.com/soonover/weknown/blob/main/weknown.php): `weknown.php`
- [Settings](https://github.com/soonover/weknown/blob/main/src/WeKnown/Config.php): `src/WeKnown/Config.php`
- [Config File](https://github.com/soonover/weknown/blob/main/config.json): `config.json`

### Domain Scanning

- [Domain Scanner](https://github.com/soonover/weknown/blob/main/src/WeKnown/Scanner.php): `src/WeKnown/Scanner.php`
- [DNS Resolver](https://github.com/soonover/weknown/blob/main/src/WeKnown/DnsResolver.php): `src/WeKnown/DnsResolver.php`
- [Report Formatter](https://github.com/soonover/weknown/blob/main/src/WeKnown/OutputFormatter.php): `src/WeKnown/OutputFormatter.php`

### Runtime Services

- [HTTP Client](https://github.com/soonover/weknown/blob/main/src/WeKnown/HttpClient.php): `src/WeKnown/HttpClient.php`
- [DNS Cache](https://github.com/soonover/weknown/blob/main/src/WeKnown/Cache.php): `src/WeKnown/Cache.php`
- [Logger](https://github.com/soonover/weknown/blob/main/src/WeKnown/Logger.php): `src/WeKnown/Logger.php`

### External Systems

- **Target Domains**
- **Discovery Sources**
- **Web and API Services**

### Other components

- **CLI User**
- **Terminal Output**

## Connections

- CLI User → CLI Entry: runs scan (evidence: `weknown.php`)
- Target Domains → CLI Entry: provides targets (evidence: `weknown.php`)
- CLI Entry → Settings: loads settings (evidence: `weknown.php`)
- Config File → Settings: configures (evidence: `src/WeKnown/Config.php`)
- CLI Entry → Domain Scanner: runs scan (evidence: `weknown.php`)
- CLI Entry → Report Formatter: formats help (evidence: `weknown.php`)
- CLI Entry → HTTP Client: initializes (evidence: `weknown.php`)
- CLI Entry → DNS Resolver: initializes (evidence: `weknown.php`)
- CLI Entry → DNS Cache: initializes (evidence: `weknown.php`)
- CLI Entry → Logger: initializes (evidence: `weknown.php`)
- Domain Scanner → DNS Resolver: resolves subdomains (evidence: `src/WeKnown/Scanner.php`)
- Domain Scanner → HTTP Client: requests intelligence (evidence: `src/WeKnown/Scanner.php`)
- Domain Scanner → Discovery Sources: queries discovery sources (evidence: `src/WeKnown/Scanner.php`)
- Domain Scanner → Web and API Services: queries web services (evidence: `src/WeKnown/Scanner.php`)
- DNS Resolver → DNS Cache: reads and writes (evidence: `src/WeKnown/DnsResolver.php`)
- HTTP Client → Settings: reads options (evidence: `src/WeKnown/HttpClient.php`)
- HTTP Client → Logger: logs requests (evidence: `src/WeKnown/HttpClient.php`)
- CLI Entry → Report Formatter: formats results (evidence: `weknown.php`)
- Report Formatter → Terminal Output: prints report
