Documentation

CLI

The commands you will actually use, on the backend and the frontend.

Run

./overseer.sh             # setup + launch the full app (macOS / Linux)
overseer.cmd              # setup + launch the full app (Windows)
python main.py            # or start just the backend (http://127.0.0.1:8787)

The backend serves REST, the WebSocket stream and MJPEG feeds. It loads models on first use and persists to a local SQLite database.

Frontend (in web/)

npm install               # install dependencies
npm run dev               # Vite dev server (browser, with hot reload)
npm run build             # production build to web/dist
npm run desktop           # build + launch the Electron desktop shell
npm run check             # type-check (svelte-check + tsc)

Documentation site (in website/)

npm install               # install Eleventy
npm run dev               # local preview with live reload
npm run build             # static build to website/_site

Simulation

Append ?sim to the frontend URL to drive the UI with synthetic detections, no backend or camera required.