terminal-status-panel

A colourful server status panel for a login shell. It reads the machine it runs on — system, resources, Docker and Swarm, clustered services, Traefik's wiring — and renders one dashboard sized to the terminal it is printed into.

It is a diagnostic tool, so it never fails a login: the command always exits 0, a collector that cannot answer degrades to a placeholder, and a check that runs out of its time budget says so rather than guessing.

pip install terminal-status-panel
status-full

The commands

Every one of them takes --width, --no-color, --config, --follow, --interval, --processes and --debug. See commands and command-line options.

What it shows

• SYSTEM OVERVIEW and UPDATES — OS, kernel, uptime, addresses, pending Debian/Ubuntu package updates, beside a pre-rendered OS logo.
• SYSTEM STATUS — load, CPU per core, memory, swap, filesystems, and the processes ranked by CPU and by memory (about the process lists).
• DOCKER INFOS — Swarm facts, node health, and a matrix of services per node, with the image each runs, the memory its tasks hold, and a TROUBLE block for anything that fell over recently (about the Docker panel).
• CLUSTER HEALTH — read-only probes of PostgreSQL, MongoDB, Kafka, GlusterFS and RustFS, plus WireGuard peers and DNS consistency (about the cluster health checks).
• TRAEFIK WIRING — entrypoint → router → middleware → service, reconstructed from Docker labels and the file provider (about the Traefik wiring view).

The status vocabulary

⬜, … and ✗ are three different statements and are never conflated. The full table is in the icon vocabulary.

What it may do to your machine

The panel opens no database or broker connection and holds no credentials. Its only privilege is the Docker socket: the Docker section reads the Swarm API, and the health section additionally executes read-only status commands inside the service containers (pg_autoctl show state or pg_isready, db.hello(), kafka-metadata-quorum.sh, a /health curl). GlusterFS is queried on the host via sudo -n and is skipped when that is unavailable.

To draw Traefik's wiring it reads Traefik's static and dynamic configuration: Docker configs through the API, and files bind-mounted into the Traefik container, from the host, as the logged-in user — only on the node the Traefik task runs on, at most 1 MiB per file and 64 files for the whole provider directory — its tree, across every mount under it — and never more than 10,000 directory entries scanned.

Documentation

The full documentation lives in docs/ and builds with Sphinx (make docs).

• Run the panel for the first time — start here.
• Run the panel at login — the profile.d snippet, and why not update-motd.d.
• Configuration — every key, its default and what it does.
• Diagnose an empty panel — what --debug reports and how to read it.
• Requirements and stability — supported platforms, and why there is no public Python API before 1.0.

Changes are recorded in CHANGELOG.md.

License

Licensed under the EUPL-1.2.