hdmistat/README.md
2025-07-23 12:56:49 +02:00

2.6 KiB

hdmistat

A beautiful system statistics display daemon for Linux framebuffers. Perfect for Raspberry Pis and other headless systems.

Features

  • 🖥️ Direct framebuffer rendering (no X11/Wayland required)
  • 📊 Real-time system statistics (CPU, memory, disk, network)
  • 🎨 Beautiful typography using IBM Plex Mono
  • 🔄 Configurable screen carousel
  • 🚀 Lightweight and efficient
  • 🔧 Easy systemd integration

Installation

go install git.eeqj.de/sneak/hdmistat/cmd/hdmistat@latest
sudo hdmistat install

Usage

Run as daemon

sudo hdmistat daemon

Install systemd service

sudo hdmistat install

Check status

hdmistat status

Display system info

hdmistat info

Configuration

Create /etc/hdmistat/config.yaml:

framebuffer: /dev/fb0
rotation_interval: 10s
screens:
  - overview
  - top_cpu
  - top_memory
  - network_detail

Building from Source

git clone https://git.eeqj.de/sneak/hdmistat
cd hdmistat
make build

Requirements

  • Linux with framebuffer support
  • Go 1.21+
  • Root access for framebuffer device

License

MIT License

Copyright (c) 2024

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

Made with love and lots of expensive SOTA AI by sneak in Berlin in the summer of 2025.

Released as a free software gift to the world, no strings attached, under the WTFPL license.

Contact: sneak@sneak.berlin

https://keys.openpgp.org/vks/v1/by-fingerprint/5539AD00DE4C42F3AFE11575052443F4DF2A55C2