staxsys documentation
Choose a version
Version 1.x
StaxSys documentation #
StaxSys is a real-time terminal dashboard for CPU, memory, disk, network, and
top-process activity. It is a lightweight, open-source utility built with
Node.js and one runtime dependency, blessed, that reads metrics from the
operating system’s own native APIs.
The current release is 1.0.0. It renamed the former vibe-sysmonitor
project and moved configuration and history into the staxsys namespace.
StaxSys is the open-source core of the StaxDash monitoring family. It is MIT licensed, and its collectors feed the hosted and on-prem commercial products (StaxLens and StaxMonitor) without locking users into them.
The terminal tool is not itself a monitoring service. Platform coverage varies by metric, and Windows network and process sampling is slower because it invokes PowerShell. Review the architecture and platform table before depending on a particular metric.
Install #
Homebrew #
The current repository documentation supports the StaxDash tap on macOS and Homebrew-on-Linux:
brew tap StaxDash/tap
brew install staxsys
The formula installs a standalone binary and does not require Node.js. Because Homebrew and automated standalone packaging were added after the 1.0.0 changelog entry, confirm that the required artifact exists in the latest GitHub release before automating an installation.
Standalone release #
Download the binary for your operating system from
GitHub Releases, rename it to
staxsys if necessary, make it executable on Unix-like systems, and place it
on your PATH. Release automation targets Linux, macOS, and Windows.
Source checkout #
Source operation requires Node.js 18.15 or newer:
git clone https://github.com/StaxDash/staxsys.git
cd staxsys
npm install
npm start
Quick start #
staxsys
staxsys --iface eth0,wlan0
staxsys --disk /,/home
staxsys --interval 1500
The first command monitors the root disk and automatically detects network
interfaces. Use q or Ctrl+C to exit.
Documentation #
- Usage and configuration — controls, flags, JSON settings, alerts, themes, and persisted history.
- Architecture and platform support — collectors, native data sources, data flow, and operating-system limitations.
- Development and releases — tests, standalone builds, continuous integration, and contribution boundaries.
StaxSys is available under the MIT licence.