Skip to content

Real-time network monitor + outbound firewall — see & block every connection. Privacy-first, local-first, Rust fleet agent, SIEM exports, 8 languages. / Moniteur réseau temps réel + pare-feu sortant, agent de flotte Rust, exports SIEM. 100 % local.

docs: GEO/SEO — llms.txt, CITATION.cff, comparison section EN/FR, Electron 44

MoneyLisabd2da9f0898f
diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644
index 0000000..1687d80
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,21 @@
+# EN: Citation metadata — GitHub renders this in the "Cite this repository"
+# sidebar widget, and reference managers (Zotero etc.) can import it.
+# FR: Métadonnées de citation — GitHub l'affiche dans le widget « Cite this
+# repository » et les gestionnaires de références peuvent l'importer.
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below. / Si vous utilisez ce logiciel, merci de le citer ainsi."
+title: "Snitch — Real-time network traffic visualizer"
+authors:
+ - name: "aiXis"
+ website: "https://aixis.fr/"
+url: "https://github.com/aixisstudio/Snitch"
+repository-code: "https://github.com/aixisstudio/Snitch"
+license: AGPL-3.0-or-later
+keywords:
+ - network monitor
+ - packet capture
+ - privacy
+ - traffic visualization
+ - cybersecurity
+version: "1.1.0"
+date-released: "2026-10-01"
diff --git a/README.md b/README.md
index 3475914..1768702 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,13 @@ See every connection your computer makes — who it talks to, where they are, an
The entire interface is available in **English and French**: use the `EN / FR` toggle in the top-right toolbar.
+### Why Snitch?
+
+- **vs Little Snitch / Lulu** — those are macOS firewalls that *block* connections; Snitch *visualizes and explains* traffic, is cross-platform, free and open-source.
+- **vs GlassWire** — Snitch is free, open-source (AGPL), requires no account and makes **zero outbound calls**; even geolocation is offline.
+- **vs Wireshark** — Snitch gives a live, high-level overview anyone can read, instead of raw packet dissection.
+- **vs cloud-based monitors** — everything runs on `127.0.0.1` behind a token; your traffic data never leaves the machine.
+
### Features
| Feature | Description |
@@ -48,7 +55,7 @@ The entire interface is available in **English and French**: use the `EN / FR` t
| Packet capture | ctypes → libpcap — Npcap (Windows) / libpcap (Linux/macOS) — own parser (IPv4/IPv6/TCP/UDP/DNS/TLS-SNI) |
| Backend API | FastAPI — WebSockets — SQLite |
| Frontend | React 18 — Vite — D3.js v7 — TopoJSON |
-| Desktop wrapper | Electron 33 |
+| Desktop wrapper | Electron 44 |
| Geolocation | **Offline only** — DB-IP Lite (CC BY 4.0) bundled gzip'd in `backend/data/geo/`, decompressed on first run; MaxMind GeoLite2 `.mmdb` also supported |
### Security & privacy
@@ -165,6 +172,13 @@ Voyez chaque connexion que votre ordinateur établit — à qui il parle, où se
Toute l'interface est disponible en **français et en anglais** : utilisez le sélecteur `EN / FR` dans la barre d'outils en haut à droite.
+### Pourquoi Snitch ?
+
+- **vs Little Snitch / Lulu** — ce sont des pare-feux macOS qui *bloquent* les connexions ; Snitch *visualise et explique* le trafic, est multiplateforme, gratuit et open-source.
+- **vs GlassWire** — Snitch est gratuit, open-source (AGPL), sans compte et n'effectue **aucun appel sortant** ; même la géolocalisation est hors ligne.
+- **vs Wireshark** — Snitch offre une vue d'ensemble en direct lisible par tous, plutôt qu'une dissection brute de paquets.
+- **vs les moniteurs cloud** — tout tourne sur `127.0.0.1` derrière un jeton ; vos données de trafic ne quittent jamais la machine.
+
### Fonctionnalités
| Fonctionnalité | Description |
@@ -190,7 +204,7 @@ Toute l'interface est disponible en **français et en anglais** : utilisez le s
| Capture de paquets | ctypes → libpcap — Npcap (Windows) / libpcap (Linux/macOS) — parseur maison (IPv4/IPv6/TCP/UDP/DNS/SNI-TLS) |
| API backend | FastAPI — WebSockets — SQLite |
| Frontend | React 18 — Vite — D3.js v7 — TopoJSON |
-| Conteneur bureau | Electron 33 |
+| Conteneur bureau | Electron 44 |
| Géolocalisation | **Hors ligne uniquement** — DB-IP Lite (CC BY 4.0) embarquée gzipée dans `backend/data/geo/`, décompressée au premier lancement ; MaxMind GeoLite2 `.mmdb` aussi pris en charge |
### Sécurité & confidentialité
diff --git a/llms.txt b/llms.txt
new file mode 100644
index 0000000..e9e1f67
--- /dev/null
+++ b/llms.txt
@@ -0,0 +1,72 @@
+# Snitch
+
+> Snitch is a free, open-source (AGPL-3.0), privacy-first real-time network
+> traffic visualizer for macOS, Windows and Linux. It shows every connection
+> your computer makes — which remote hosts, where they are located, and which
+> local process is responsible — as a living node graph and world map.
+> All analysis is 100% local: no telemetry, no cloud calls, offline GeoIP.
+> Snitch est un visualiseur de trafic réseau en temps réel, gratuit,
+> open-source et respectueux de la vie privée — interface entièrement
+> bilingue anglais/français.
+
+Snitch passively captures packets on the local machine (libpcap/Npcap),
+enriches them locally (DNS answers, TLS SNI, reverse DNS, offline
+DB-IP Lite geolocation, IEEE OUI vendor table), and renders a live D3.js
+force graph plus an interactive world map. A privacy score rates the
+outgoing traffic exposure in real time, and anomaly detection flags port
+scans, beaconing and possible exfiltration.
+
+## What it does
+
+- Live force graph: your machine at the center, LAN devices inside a dashed
+ perimeter ring, external hosts on an outer orbit
+- Interactive world map with geolocated IPs and animated arcs (offline GeoIP
+ — DB-IP Lite bundled, zero network calls)
+- Anomaly detection: port scans, beaconing, exfiltration heuristics
+- Process attribution: which app generates which traffic, per-app history
+- Passive LAN discovery via the system ARP table (no broadcast scans)
+- Privacy score, bandwidth sparkline, 15/30/60-min sliding timeline (SQLite,
+ 24 h retention), persisted alert-suppression rules
+- Fully bilingual UI: English and French, one-click toggle
+
+## Security model
+
+- Loopback-only by default (127.0.0.1); token auth on every REST endpoint
+ and the WebSocket; origin allowlist for CORS/WS
+- No outbound calls at runtime except one explicitly consent-gated,
+ optional DB-IP Lite update from the Settings panel
+- Capture requires privileges: root/sudo on macOS (/dev/bpf) and Linux
+ (cap_net_raw), Administrator + Npcap on Windows
+
+## Tech stack
+
+- Backend: Python 3.11+, FastAPI, WebSockets, SQLite, ctypes→libpcap
+ (own IPv4/IPv6/TCP/UDP/DNS/TLS-SNI parser — no Scapy)
+- Frontend: React 18, Vite, D3.js v7, TopoJSON
+- Desktop: Electron 44 (Windows installer via electron-builder)
+- Installable 1-click via Pinokio (launcher scripts at repo root)
+
+## Compared to similar tools
+
+- vs **Little Snitch / Lulu** (macOS firewalls): Snitch visualizes and
+ explains traffic rather than blocking it; cross-platform, free,
+ open-source
+- vs **GlassWire**: free, open-source, no account, no cloud, offline GeoIP
+- vs **Wireshark**: high-level live overview for non-specialists instead of
+ raw packet dissection
+
+## Links
+
+- Repository: https://github.com/aixisstudio/Snitch
+- Documentation: README.md (English + Français), docs/threat-model.md,
+ PRIVACY.md, SECURITY.md, CONTRIBUTING.md
+- License: AGPL-3.0-or-later (LICENSE)
+- Third-party notices: THIRD_PARTY_NOTICES.md (DB-IP Lite CC BY 4.0)
+- Author: aiXis — https://aixis.fr/
+
+## Français
+
+Snitch visualise en temps réel tout le trafic réseau de votre machine :
+graphe de nœuds vivant, carte du monde géolocalisée (GeoIP hors ligne),
+score de confidentialité, détection d'anomalies, attribution par processus.
+100 % local, sans télémétrie, bilingue EN/FR, open-source AGPL.