Documentation

Quick Start

Run the backend, open the console, connect a source, and see live detections in a couple of minutes.

Fastest: one command

From the repository root:

# macOS / Linux
./overseer.sh

# Windows
overseer.cmd

On the first run this sets up the Python dependencies and AI models, then launches Overseer: the desktop app if Node.js is installed, otherwise in your browser at http://127.0.0.1:8787. It is the recommended way to run the project.

Or start it manually

python main.py            # backend only, at http://127.0.0.1:8787

Open the console

Either the desktop shell or a browser:

# Desktop (Electron)
cd web && npm run desktop

# or just open the served URL in a browser
# http://127.0.0.1:8787

Connect a source

  1. On the landing screen choose Begin Observation.
  2. Pick a camera (a demo source is seeded on a fresh install), or add an RTSP/ONVIF URL under Manage Sources.
  3. The live feed opens in the POV view with detections overlaid.

Try the overlays

From the left Modules rail:

  • Toggle DETECTION classes (person / vehicle / animal / weapon). Disabling a class sheds its load across the whole pipeline.
  • Turn on TACTICAL for the top-down god-view radar and FORESIGHT for predictive ghosts.
  • Open 3D SPATIAL to lift the frame into a navigable point cloud.
Tip

No camera handy? A simulation mode drives synthetic detections in the browser at /?sim for a quick tour of the UI.

Next

Tune behaviour in Configuration.