Skip to content

Repository Layout

Emre Yavuz edited this page Aug 2, 2026 · 1 revision

Repository Layout

Top-level directories and what they hold.

Backend (Python)

Directory Purpose
server/ FastAPI app (app.py), the Backend orchestrator (backend.py), the AI Operator LLM client (ai_llm.py), speech-to-text (stt.py), text-to-speech (tts.py), enhance (enhance.py), super-resolution (sr_model.py), the roster harvester (roster.py), spatial build, camera DNA and suggestions.
core/ Config loading, logging setup, shared primitives.
plugins/ The detection / analysis plugin base and detection dataclasses.
camera/ Camera capture, reconnect, source management.
analyzers/ Scene-condition analysers (day/night, fog, rain, wind, weather).
anomaly/ Learned unusual-activity detection.
events/ Event model and throttling.
alerts/ Alert rule engine and cooldowns.
zones/ Area and line zones.
trajectory/ Movement events and behaviour: monitor.py (running / stopped / U-turn) and intent.py (posture + motion intents).
pose/ Body pose estimation.
objects/ Object-of-interest visual tracker.
vehicle/ Vehicle attribute classifiers: make.py (brand ViT), bodytype.py (zero-shot CLIP body type).
forensic/ Attribute extraction (attributes.py), colour naming (palette.py), the query parser and the unified forensic search.
match/ Appearance-search engine, ReID encoders and tools/export_models.py (model fetch / export).
vision/ Shared vision helpers.
analyzers/, ai/ Analysis helpers and AI glue.
storage/ SQLite schema and access (database.py), the snapshot service (snapshots.py).
export/ Report / data export.
api/ Auxiliary REST / metrics surface.
utils/ Miscellaneous helpers.

Frontend

Directory Purpose
web/src Svelte 5 UI: components/ (map, POV, rails, modes, overlays, operator console, alerts board), lib/ (api.ts, ws.ts, stores.ts, operator.ts, motion.ts, types.ts, speech.ts), and screens.
web/electron The Electron shell (main.cjs).
web/dist Production build output (committed so the packaged app ships it).

Project & ops

Directory / file Purpose
config/ default.yaml runtime configuration.
models/ Vendored / fetched model weights (git ignored).
data/ SQLite db, snapshots, clips, media, recordings, thumbs, exports (git ignored).
tests/ Pytest suite (600+ tests).
website/ The Eleventy documentation site (deployed to GitHub Pages).
docs/, design/, demo/, scripts/ Docs assets, design notes, demo material, helper scripts (including spatial-render verification harnesses).
overseer.cmd, overseer.sh Convenience launchers.
pyproject.toml Python deps (uv), pinned to Python 3.12 and torch cu124.
.github/workflows/ release.yml (desktop installers), deploy-docs.yml (docs site).

Clone this wiki locally