bandwhich README

The project's README from github.com/imsnif/bandwhich. As one markdown file: README.md.

bandwhich

demo

This is a CLI utility for displaying current network utilization by process, connection and remote IP/hostname

Table of contents

Project status

This project is in passive maintenance. Critical issues will be addressed, but no new features are being worked on. However, this is due to a lack of funding and/or manpower more than anything else, so pull requests are more than welcome. In addition, if you are able and willing to contribute to this project long-term, we would like to invite you to apply for co-maintainership.

For more details, see The Future of Bandwhich #275.

How does it work?

bandwhich sniffs a given network interface and records IP packet size, cross referencing it with the /proc filesystem on linux, lsof on macOS, or using WinApi on windows. 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

Downstream packaging status

For detailed instructions for each platform, see INSTALL.md.

Packaging status

Download a prebuilt binary

We offer several generic binaries in releases for various OSes.

OSArchitectureSupportUsage
Androidaarch64Best effort

All modern Android devices.

Note that this is a pure binary file, not an APK suitable for general usage.
Linuxaarch64Full 64-bit ARMv8+ (servers, some modern routers, RPi-4+).
armv7hfBest effort32-bit ARMv7 (older routers, pre-RPi-4).
x64Full Most Linux desktops & servers.
MacOSaarch64Full Apple silicon Macs (2021+).
x64 Intel Macs (pre-2021).
Windowsx64Full Most Windows desktops & servers.

Building from source

git clone https://github.com/imsnif/bandwhich.git
cd bandwhich
cargo build --release

For the up-to-date minimum supported Rust version, please refer to the rust-version field in Cargo.toml.

Cross-compiling

Cross-compiling for alternate targets is supported via cross. Here's the rough procedure:

  1. Check the target architecture. If on Linux, you can use uname -m.
  2. Lookup rustc platform support for the corresponding target triple.
  3. Install cross.
  4. Run cross build --release --target <TARGET_TRIPLE>.

Android

Until cross-rs/cross#1222 is solved, use the latest HEAD:

cargo install --git https://github.com/cross-rs/cross.git cross
cross build --release --target aarch64-linux-android

Post install (Linux)

Since bandwhich sniffs network packets, it requires elevated privileges. On Linux, there are two main ways to accomplish this:

1. setcap

# assign capabilities
sudo setcap cap_sys_ptrace,cap_dac_read_search,cap_net_raw,cap_net_admin+ep $(command -v bandwhich)
# run as unprivileged user
bandwhich

Capabilities explained

2. sudo (or alternative)

sudo bandwhich

Note that if your installation method installed bandwhich to somewhere in your home directory (you can check with command -v bandwhich), you may get a command not found error. This is because in many distributions, sudo by default does not keep your user's $PATH for safety concerns.

To overcome this, you can do any one of the following:

  1. make sudo preserve your $PATH environment variable;
  2. explicitly set $PATH while running bandwhich: sudo env "PATH=$PATH" bandwhich;
  3. pass the full path to sudo: sudo $(command -v bandwhich).

Post install (Windows)

You might need to first install npcap for capturing packets on Windows.

Usage

Usage: bandwhich [OPTIONS]

Options:
  -i, --interface <INTERFACE>      The network interface to listen on, eg. eth0
  -r, --raw                        Machine friendlier output
  -n, --no-resolve                 Do not attempt to resolve IPs to their hostnames
  -s, --show-dns                   Show DNS queries
  -d, --dns-server <DNS_SERVER>    A dns server ip to use instead of the system default
      --log-to <LOG_TO>            Enable debug logging to a file
  -v, --verbose...                 Increase logging verbosity
  -q, --quiet...                   Decrease logging verbosity
  -p, --processes                  Show processes table only
  -c, --connections                Show connections table only
  -a, --addresses                  Show remote addresses table only
  -u, --unit-family <UNIT_FAMILY>  Choose a specific family of units [default: bin-bytes] [possible values: bin-bytes, bin-bits, si-bytes, si-bits]
  -t, --total-utilization          Show total (cumulative) usages
  -h, --help                       Print help (see more with '--help')
  -V, --version                    Print version

Contributing

See CONTRIBUTING.md.

License

MIT

bandwhich (imsnif/bandwhich)

Searching Database…

12K ·GitHub
Bandwhich
Что это такое?bandwhich — это CLI-утилита, которая показывает текущее использование сетевой полосы пропускания с разбивкой по процессам, соединениям и удалённым IP-адресам или именам хостов прямо в терминале.
Это GUI-приложение или панель в терминале?Это панель в терминале (TUI), которая обновляется в реальном времени в окне терминала и подстраивает набор столбцов под размер окна.
Как установить и запустить программу?Скачайте готовый бинарный файл для вашей ОС/архитектуры со страницы Releases или соберите из исходников с помощью cargo, используя cross для кросс-компиляции; инструкции для конкретных платформ смотрите в INSTALL.md.
Нужно ли что-то дополнительно, чтобы перехватывать пакеты?В Linux используются /proc и перехват сырых пакетов; в macOS — lsof; в Windows — WinApi, и, скорее всего, сначала нужно установить npcap.
Почему для запуска нужны sudo или особые права?Перехват пакетов требует повышенных привилегий, поэтому в Linux нужно либо выдать бинарному файлу возможности через setcap (capnetraw, capnetadmin, capsysptrace, capdacreadsearch), либо запускать его через sudo каждый раз.
Какие платформы и архитектуры поддерживаются?Полная поддержка для Linux x64/aarch64, macOS (Apple Silicon и Intel) и Windows x64; поддержка по мере возможности для ARMv7 Linux и Android aarch64 (в виде сырого бинарного файла, а не APK).
Проект всё ещё получает новые функции?Нет, проект находится в режиме пассивного сопровождения: критические ошибки исправляются, но новые функции активно не разрабатываются из-за нехватки финансирования и людских ресурсов, однако PR и соавторы-сопровождающие приветствуются.
Как bandwhich определяет, какому процессу принадлежит каждое соединение?Он перехватывает пакеты на заданном сетевом интерфейсе, определяя размеры IP-пакетов, и сопоставляет их с файловой системой /proc в Linux, lsof в macOS или WinApi в Windows, чтобы привязать трафик к процессам.
Можно ли показывать имена хостов вместо сырых IP?Да, в фоновом режиме он по мере возможности выполняет обратные DNS-запросы, чтобы преобразовать удалённые IP-адреса в имена хостов.
Если я установил программу в свой домашний каталог, почему sudo пишет «command not found»?В sudo многих дистрибутивов не сохраняется ваш пользовательский $PATH, поэтому нужно либо сохранить $PATH для sudo, либо запускать так: sudo env PATH=$PATH bandwhich, либо передать sudo полный путь через sudo $(command -v bandwhich).
What are similar projects?bottom, gping, telegraf, lsoff, bpytop, goreplay, ctop, neofetch
Which topics is it in?network-monitoring, system-monitor, privacy-tools, sysadmin, monitoring, command-line, dashboard, networking, rust, command-line-tool, android, terminal
Creator
imsnif
Size
5.4 MB
Stars
12K
Updated
CommitMay 14Releasev0.23.1Oct 08
Age
7y
Commits · 90 Days