Skip to content

klyrek-dashboard

Status: built, not yet on PyPI (blocked on PyPI's new-project rate limit) — install from source

An interactive terminal UI (built on Textual) for browsing a saved scan result — no browser required, and deliberately not a web dashboard.

from klyrek_dashboard.app import run_dashboard   # blocking call

run_dashboard(result)

Or from the command line, for a scan already saved as JSON:

klyrek crawl https://shop.sandbox.klyrek.com --format json -o ./scans
klyrek dashboard ./scans/shop.sandbox.klyrek.com_<timestamp>.json

Three tabs — Findings, Endpoints, Technologies — each backed by a DataTable. Press q to quit. On Termux, widen your terminal window (or use a Bluetooth keyboard session) since DataTable widgets need real width to stay readable — see Termux Setup.

API reference

klyrek_dashboard.app

An interactive terminal dashboard for browsing a Klyrek ScanResult.

DashboardApp 

DashboardApp(result: ScanResult)

Bases: App[None]

Interactive terminal dashboard for a single Klyrek ScanResult.

Source code in klyrek_dashboard\app.py 
29
30
31
def __init__(self, result: ScanResult) -> None:
    super().__init__()
    self.result = result

run_dashboard 

run_dashboard(result: ScanResult) -> None

Launch the interactive terminal dashboard for a ScanResult (blocking call).

Source code in klyrek_dashboard\app.py 
93
94
95
def run_dashboard(result: ScanResult) -> None:
    """Launch the interactive terminal dashboard for a ScanResult (blocking call)."""
    DashboardApp(result).run()