Skip to content

netstat ​

Network traffic counters (up/down rates).

Add it to your layout with netstat:

yaml
bar:
  layout:
    - monitor: "*"
      right: [netstat]

General ​

FieldTypeDefaultDescription
poll-interval-msu642000Polling interval in milliseconds.
interfacestring"auto"Network interface to monitor.
formatstring"{{ down_auto }} {{ up_auto }}"Format string for the label.
icon-namestring"ld-activity-symbolic"Icon name.
border-showboolfalseDisplay border around button.
icon-showbooltrueDisplay module icon.
label-showbooltrueDisplay label.
label-max-lengthu320Max label characters before truncation. Set to 0 to disable.
More about poll-interval-ms

Faster polling increases CPU usage.

More about interface

Use "auto" to select the first active interface, or specify an interface name like "eth0" or "wlan0".

More about format

Download Placeholders ​

  • {{ down_kib }} - Download speed in KiB/s
  • {{ down_mib }} - Download speed in MiB/s
  • {{ down_gib }} - Download speed in GiB/s
  • {{ down_auto }} - Download speed with auto unit (e.g., "1.5 MiB/s")

Upload Placeholders ​

  • {{ up_kib }} - Upload speed in KiB/s
  • {{ up_mib }} - Upload speed in MiB/s
  • {{ up_gib }} - Upload speed in GiB/s
  • {{ up_auto }} - Upload speed with auto unit (e.g., "256 KiB/s")

Other Placeholders ​

  • {{ interface }} - Interface name (e.g., "wlan0")

Examples ​

  • "{{ down_auto }} {{ up_auto }}" - "1.5 MiB/s 256 KiB/s"
  • "D:{{ down_mib }} U:{{ up_mib }}" - "D:1.5 U:0.2"
  • "{{ interface }}: {{ down_auto }}" - "wlan0: 1.5 MiB/s"

Colors ​

FieldTypeDefaultDescription
border-colorColorValue"red"Border color token.
icon-colorColorValue"auto"Icon foreground color.
icon-bg-colorColorValue"red"Icon container background color token.
label-colorColorValue"fg-default"Label text color token.
button-bg-colorColorValue"bg-surface-elevated"Button background color token.

Click actions ​

FieldTypeDefaultDescription
left-clickClickAction""Action on left click.
right-clickClickAction""Action on right click.
middle-clickClickAction""Action on middle click.
scroll-upClickAction""Action on scroll up.
scroll-downClickAction""Action on scroll down.

Default configuration ​

yaml
modules:
  netstat:
    poll-interval-ms: 2000
    interface: auto
    format: '{{ down_auto }} {{ up_auto }}'
    icon-name: ld-activity-symbolic
    border-show: false
    border-color: red
    icon-show: true
    icon-color: auto
    icon-bg-color: red
    label-show: true
    label-color: fg-default
    label-max-length: 0
    button-bg-color: bg-surface-elevated
    left-click: ""
    right-click: ""
    middle-click: ""
    scroll-up: ""
    scroll-down: ""

Released under the MIT License.