https://github.com/stone/i3blocks-bandwidth
Custom i3blocks bandwidth block
https://github.com/stone/i3blocks-bandwidth
Last synced: 12 months ago
JSON representation
Custom i3blocks bandwidth block
- Host: GitHub
- URL: https://github.com/stone/i3blocks-bandwidth
- Owner: stone
- License: mit
- Created: 2025-01-29T18:02:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-30T06:54:02.000Z (over 1 year ago)
- Last Synced: 2025-03-30T19:16:37.640Z (over 1 year ago)
- Language: Zig
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Custom i3blocks bandwidth block
A customizable bandwidth monitor for i3blocks written in Zig.
## Features
- Monitor network interface bandwidth (Rx/Tx)
- Support for bits/s and bytes/s output
- Configurable warning and critical thresholds with color output
- SI units support
- Multiple interface monitoring
- Configurable refresh rate
## Building
Requires Zig 0.13 or later.
```shell
zig build
zig-out/bin/bandwidth -h
```
The binary is:
```shell
zig-out/bin/bandwidth
```
Copy it to a directory in your path for easy access:
```shell
cp zig-out/bin/bandwidth ~/.local/bin
```
Or if you prefer, let zig install it in your home directory (assuming `~/.local/bin` is in your `$PATH`):
```shell
zig build -Doptimize=ReleaseSafe --prefix ~/.local
```
`bandwidth` is a single statically linked binary. No further runtime files are required.
You may install it on another system by simply copying the binary.
It can be cross compiled to other platforms using zig's `-Dtarget`
```shell
zig build -Dtarget=x86_64-linux
zig build -Dtarget=aarch64-linux
zig build -Dtarget=arm-linux
```
## Installation
1. Build the binary
2. Copy it to your i3blocks scripts directory (typically `~/.config/i3blocks/scripts/`)
3. Make it executable: `chmod +x ~/.config/i3blocks/scripts/bandwidth`
## Configuration
Add to your i3blocks configuration:
```ini
[bandwidth]
command=$SCRIPT_DIR/bandwidth
interval=persist
markup=pango
label=
min_width=20000.0 B/s 20000.0 B/s
color=#000
```
## Flags
```
-b, --bits
use bits/s
-B, --bytes
use bytes/s (default)
-t, --seconds
refresh time (default is 1)
-i, --interfaces
interfaces to monitor, comma separated (default all except lo)
-w, --warning
set warning (default orange) for Rx:Tx bandwidth
-W, --warningcolor
set warning color (#RRGGBB)
-c, --critical
set critical (default red) for Rx:Tx bandwidth
-C, --criticalcolor
set critical color (#RRGGBB)
-s, --si
use SI units (default is IEC)
-h, --help
print this help message
```
## Example Output
```
1.0KB/s 5.0 B/s
8.0MB/s 2.7KB/s
```
## License
MIT