bandwhich

# bandwhich

![demo](res/demo.gif)

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

## Table of contents

- [bandwhich](#bandwhich)
  - [Table of contents](#table-of-contents)
  - [Project status](#project-status)
  - [How does it work?](#how-does-it-work)
  - [Installation](#installation)
    - [Downstream packaging status](#downstream-packaging-status)
    - [Download a prebuilt binary](#download-a-prebuilt-binary)
  - [Building from source](#building-from-source)
    - [Cross-compiling](#cross-compiling)
      - [Android](#android)
  - [Post install (Linux)](#post-install-linux)
    - [1. `setcap`](#1-setcap)
      - [Capabilities explained](#capabilities-explained)
    - [2. `sudo` (or alternative)](#2-sudo-or-alternative)
  - [Post install (Windows)](#post-install-windows)
  - [Usage](#usage)
  - [Contributing](#contributing)
  - [License](#license)

## 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](https://github.com/imsnif/bandwhich/issues/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](INSTALL.md).

<a href="https://repology.org/project/bandwhich/versions">
  <img src="https://repology.org/badge/vertical-allrepos/bandwhich.svg?columns=3" alt="Packaging status">
</a>

### Download a prebuilt binary

We offer several generic binaries in [releases](https://github.com/imsnif/bandwhich/releases) for various OSes.

<table>
  <thead>
    <th>OS</th><th>Architecture</th><th>Support</th><th>Usage</th>
  </thead>
  <tbody>
    <tr>
      <td>Android</td><td>aarch64</td><td>Best effort</td>
      <td>
        <p>All modern Android devices.</p>
        <p>Note that this is a pure binary file, not an APK suitable for general usage.</p>
      </td>
    </tr>
    <tr>
      <td rowspan="3">Linux</td><td>aarch64</td><td>Full</td>
      <td>64-bit ARMv8+ (servers, some modern routers, RPi-4+).</td>
    </tr>
    <tr>
      <td>armv7hf</td><td>Best effort</td><td>32-bit ARMv7 (older routers, pre-RPi-4).</td>
    </tr>
    <tr>
      <td>x64</td><td>Full</td>
      <td>Most Linux desktops & servers.</td>
    </tr>
    <tr>