source/bandwhich
1
0
Fork 0
mirror of https://github.com/imsnif/bandwhich.git synced 2026-02-09 01:59:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): add demo and more details

Browse Source
This commit is contained in:
Aram Drevekenin
2019-10-17 22:00:51 +02:00
committed by GitHub
parent ad1fab3c36
commit eb470af8ea
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,11 +1,23 @@
### what
Display current network utilization by process and connection.
## what
...is taking up my bandwidth?!
This is my first attempt at Rust and is still very much a WIP. :)
![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 (provided as the second cli argument, eg. `what eth0`) and records packet size, cross referencing it with the `/proc` filesystem.
`what` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem.
Currently, it relies on the display loop to reset its state every second and thus always display the bandwidth per second.
`what` is responsive to the terminal window size, displaying less info if there is no room for it.
At the moment there is only a linux implementation but the tests should (hopefully!) run on all platforms.
`what` will 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.
### 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`.