matthart1983/netwatchReal-time network diagnostics in your terminal. One command, zero config, instant visibility.
<p align="center">
<h1 align="center">NetWatch</h1>
<p align="center">
<strong>Network diagnostics in your terminal.</strong>
</p>
<p align="center">
<a href="https://crates.io/crates/netwatch-tui"><img src="https://img.shields.io/crates/v/netwatch-tui.svg" alt="crates.io"></a>
<a href="https://crates.io/crates/netwatch-tui"><img src="https://img.shields.io/crates/d/netwatch-tui.svg" alt="downloads"></a>
<a href="https://github.com/matthart1983/netwatch/releases"><img src="https://img.shields.io/github/v/release/matthart1983/netwatch" alt="Release"></a>
<a href="https://github.com/matthart1983/netwatch/releases"><img src="https://img.shields.io/github/downloads/matthart1983/netwatch/total?label=GitHub%20downloads" alt="GitHub release downloads"></a>
<a href="https://anaconda.org/conda-forge/netwatch"><img src="https://img.shields.io/conda/dn/conda-forge/netwatch?label=conda%20downloads" alt="conda-forge downloads"></a>
<img src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-blue" alt="Platform">
<img src="https://img.shields.io/badge/license-MIT-green" alt="License">
</p>
<p align="center">
<a title="Tool of The Week on Terminal Trove" href="https://terminaltrove.com/netwatch/"><img src="https://raw.githubusercontent.com/matthart1983/netwatch/HEAD/docs/media/terminal_trove_totw_badge.svg" alt="Terminal Trove Tool of The Week" height="54" /></a>
</p>
</p>
<p align="center">
<img src="https://assets.kitploit.com/production/public/readmes/12174/1b8078ec5c4fa4c006fec00eed1fc6790e51acdeb951ed2069c288bcaedd2be0.gif" alt="NetWatch's dense view: a mirrored braille throughput graph with download above the axis and upload below, per-interface rates with sparklines, four-hop latency budgets, and a connection table with the selected socket's kernel TCP state" width="900">
</p>
<p align="center">
<em><code>netwatch --view dense</code>. Four boxes, no chrome, every keybind on a border. Download grows up from the axis, upload grows down.</em>
</p>
One binary, no config. `sudo netwatch` and you have live capture with L7 decode, process attribution where available, and a diagnostic engine that opens an issue when a learned baseline breaks and closes it when the fix holds.
## Install
```bash
brew install netwatch # macOS / Linux
scoop install netwatch # Windows (needs Npcap)
cargo binstall netwatch-tui # prebuilt binary, anywhere with Rust
paru -S netwatch-tui # Arch (AUR)
nix-shell -p netwatch # NixOS / Nix
conda install -c conda-forge netwatch # conda / mamba (Linux, macOS)
```
**Debian / Ubuntu** ([apt repository](https://matthart1983.github.io/netwatch/)):
```bash
curl -fsSL https://matthart1983.github.io/netwatch/apt/netwatch.gpg \
| sudo tee /usr/share/keyrings/netwatch.gpg >/dev/null
echo "deb [signed-by=/usr/share/keyrings/netwatch.gpg] \
https://matthart1983.github.io/netwatch/apt stable main" \
| sudo tee /etc/apt/sources.list.d/netwatch.list
sudo apt update && sudo apt install netwatch
```
**Fedora:** `sudo dnf copr enable matthart1983/netwatch && sudo dnf install netwatch`
**Container:** `docker run --rm -it --net=host --pid=host --cap-add=NET_RAW ghcr.io/matthart1983/netwatch`
**Binaries** for macOS, Linux (x86_64, aarch64, armv5te), FreeBSD (x86_64) and
Windows are on the
[releases page](https://github.com/matthart1983/netwatch/releases/latest), with
`.deb`, `.rpm`, checksums and signed provenance. The Linux builds are static and
need nothing installed; Windows needs [Npcap](https://npcap.com/#download).
**FreeBSD** is best-effort. `netwatch-freebsd-x86_64` is built on FreeBSD 13.5 and
dynamically links the base system's libc and libpcap, so it needs FreeBSD 13 or
newer (it cannot be static). On anything older, build from source with
`cargo install netwatch-tui`.
[Verifying a download](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#verifying-a-download) ·
[every channel](https://github.com/matthart1983/netwatch/blob/main/docs/PACKAGING.md).
## Run
```bash
netwatch # interfaces, connections, config. No privileges.
sudo netwatch # enables capture where elevated access is required
netwatch --lite # one 80x24 screen
netwatch --view dense # four boxes, 130x44 or larger
```
`1` to `9` and `0` switch tabs, `V` cycles the three views, `?` shows every key. To run without sudo on Linux, grant the capabilities once: `sudo setcap 'cap_net_raw,cap_bpf,cap_perfmon+eip' "$(which netwatch)"` ([why and when to repeat it](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#running-without-sudo-linux)).
### Without the TUI
```bash
netwatch doctor # what netwatch can see on this host, and why not
netwatch diagnose run --budget 30s # one bounded diagnosis; exit 0 clean, 1 issue, 2 no evidence
netwatch diagnose run --format json # the same, for scripts
netwatch daemon --metrics # headless; Prometheus /metrics on 127.0.0.1:9464
netwatch --demo # replay a recorded Diagnose incident, no capture needed
```
`daemon` runs the same collectors with no screen; a [systemd unit](https://github.com/matthart1983/netwatch/blob/main/packaging/systemd/netwatch.service) and a [launchd agent](https://github.com/matthart1983/netwatch/blob/main/packaging/launchd/com.netwatch.agent.plist) ship with it, and [Prometheus export](https://github.com/matthart1983/netwatch/blob/main/docs/observability-export.md) lists the metrics. `--remote URL` with `NETWATCH_API_KEY` streams snapshots to a backend you run; it is experimental and its wire format may change. [Every command and flag](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#command-line).
## The tabs
| # | Tab | Shows |
|---|-----|-------|
| 1 | Dashboard | Latency tiles, mirrored throughput, the link carrying it, connections rolled up per process |
| 2 | Connections | Every socket with process, PID, state, GeoIP, RTT, retransmits |
| 3 | Interfaces | Addresses, MTU, rates, errors, drops |
| 4 | Packets | Live decode, TLS 1.3 decryption, JA4, stream tracking, display filters, PCAP export |
| 5 | Stats | Protocol breakdown and handshake-timing histogram |
| 6 | Topology | Machine, gateway, DNS, top hosts, traceroute |
| 7 | Timeline | Connections by TCP state, with alerts |
| 8 | Processes | Bandwidth per process |
| 9 | Diagnose | Issue, cause, fix, verified close. `report.md` from the same objects |
| 0 | Egress | Learned destinations, promoted policy, drift |
[Every keybinding](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#keyboard-controls), [display filters](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#display-filters), [decoders](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#deep-packet-inspection), [themes](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#themes), [configuration](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#configuration).
## Views
`V` cycles all three without a restart; the collectors keep running.
| View | Size | For |
|---|---|---|
| Full | any | The ten tabs above |
| Lite (`--lite`) | 80x24 | An SSH session to a Pi, or a tmux split |
| Dense (`--view dense`) | 130x44+ | The hero image: four boxes, braille throughput, kernel TCP detail |
[Why they look like this](https://github.com/matthart1983/netwatch/blob/main/docs/DESIGN-0.30.md#8-dense-and-lite).
## Docs
| | |
|---|---|
| [Reference](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md) | Keys, filters, decoders, configuration, permissions |
| [Diagnose](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#how-it-works) | Baselines, the 30 rules, ranked causes, verified closes |
| [TLS decryption](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#tls-13--12-decryption) | Point `SSLKEYLOGFILE` at netwatch and read your own traffic |
| [Egress linting](https://github.com/matthart1983/netwatch/blob/main/docs/egress-linter-plan.md) | Observe destinations, promote a policy, alert on what you block |
| [Security and forensics](https://github.com/matthart1983/netwatch/blob/main/docs/REFERENCE.md#security--forensics) | Beaconing, scans, DNS tunnelling, JA4, the flight recorder |
| [Capability matrix](https://github.com/matthart1983/netwatch/blob/main/docs/CAPABILITIES.md) | Platform differences, diagnostic limits and verification scope |
| [Attribution evidence](https://github.com/matthart1983/netwatch/blob/main/docs/attribution.md) | Identity, freshness, coverage denominators and controlled results |
| [Doctor command](https://github.com/matthart1983/netwatch/blob/main/docs/doctor.md) | Read-only setup report, JSON capabilities and optional capture check |
| [Design 0.30](https://github.com/matthart1983/netwatch/blob/main/docs/DESIGN-0.30.md) | Why the screens look the way they do |
| [Architecture](https://github.com/matthart1983/netwatch/blob/main/docs/WIKI.md) | Runtime, source map, permissions model, how to build and verify |
| [AI Insights](https://github.com/matthart1983/netwatch/blob/main/docs/INSIGHTS.md) | Optional LLM commentary inside Diagnose, off by default |
| [Prometheus export](https://github.com/matthart1983/netwatch/blob/main/docs/observability-export.md) | Exposed metrics and scrape config |
| [Packaging](https://github.com/matthart1983/netwatch/blob/main/docs/PACKAGING.md) | Every channel, and what updates it |
| [Changelog](https://github.com/matthart1983/netwatch/blob/main/CHANGELOG.md) | Every release |
Diagnose misread your network? [Open an issue](https://github.com/matthart1983/netwatch/issues/new?template=bug_report.md) with what you saw and the output of `netwatch diagnose run --format json`. It names your gateway and resolver addresses, so edit those out if you'd rather.
## Related
[SysWatch](https://github.com/matthart1983/syswatch) and [DiskWatch](https://github.com/matthart1983/diskwatch) share the chrome. [ESSH](https://github.com/matthart1983/essh) is a Rust SSH client with the same look. [NetWatch Cloud](https://www.netwatchlabs.com) is hosted fleet monitoring built on the MIT [agent](https://github.com/matthart1983/netwatch-agent), [SDK](https://github.com/matthart1983/netwatch-sdk) and [dashboard](https://github.com/matthart1983/netwatch-dashboard).
## Thanks
Much of the packaging is other people's work. Dominiquini and kemelzaidan maintain [`netwatch-tui`](https://aur.archlinux.org/packages/netwatch-tui) and [`netwatch-tui-bin`](https://aur.archlinux.org/packages/netwatch-tui-bin) on the AUR, tomasrivera the [nixpkgs package](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ne/netwatch/package.nix), [scillidan](https://github.com/scillidan) the [Scoop entry](https://github.com/ScoopInstaller/Main/blob/master/bucket/netwatch.json), [pavelzw](https://github.com/pavelzw) the [conda-forge feedstock](https://github.com/conda-forge/netwatch-feedstock), and the Homebrew maintainers took the formula into core. File packaging problems with them and netwatch bugs here.
[@lamchau](https://github.com/lamchau), [@fdncred](https://github.com/fdncred) and [@PeteE](https://github.com/PeteE) sent patches. Everyone who opened an issue with a repro or argued with a design decision is the reason the output is right on more terminals than mine.
## Contributing
[Discussions](https://github.com/matthart1983/netwatch/discussions), [issues](https://github.com/matthart1983/netwatch/issues), [CONTRIBUTING.md](https://github.com/matthart1983/netwatch/blob/main/CONTRIBUTING.md).
## License
MIT