summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 31805f8a13c365c9a71eb986a976499017b28276 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
## what
...is taking up my bandwidth?!

![demo](demo.gif)

(display current network utilization by process, connection and remote IP/hostname)

This is my first attempt at Rust. :)

### How does it work?
`what` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem. It is responsive to the terminal window size, displaying less info if there is no room for it. It will also attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis.

### Installation
At the moment, `what` is available through Cargo as a binary package.

`cargo install what`

Important note: There is only support for linux at the moment, mostly because I don't have access to anything else. I'd very much welcome contributions, and would be happy to provide guidance. Open up an issue/pr if interested.

### Usage
`what -i <interface-name>` eg. `what -i eth0`

Note that since `what` sniffs network packets, it requires root privileges - so you might want to use it with (for example) `sudo`.