staxping2 documentation
Choose a version
Version 0.2.x
StaxPing2 documentation #
StaxPing2 is a real-time terminal network diagnostic. Each monitored host gets a panel for latency, jitter, packet loss, percentiles, uptime, outages, path discovery, and optional DNS, TCP, and HTTP reachability checks.
StaxPing2 is an open-source, MIT-licensed utility. The current release is
0.2.0. It uses the operating system’s own ping command and Node.js
standard-library networking APIs, so it requires no root access or raw sockets.
StaxPing2 is a diagnostic tool, not a monitoring service or packet capture
utility. Ping cadence and path parsing vary by platform. IPv6 intermediate
traceroute hops are not fully parsed and appear as *.
Install #
Homebrew #
brew tap StaxDash/tap
brew install staxping2
The tap supports macOS and Homebrew-on-Linux using standalone release binaries. Node.js is not required for this installation path.
Standalone release #
Download the appropriate artifact from
GitHub Releases, rename it to
staxping2 if necessary, and place it on your PATH. Release automation
targets Linux, macOS, and Windows.
Source checkout #
Source operation requires Node.js 18.15 or newer and a working system ping:
git clone https://github.com/StaxDash/staxping2.git
cd staxping2
npm install
npm start
Quick start #
staxping2
staxping2 --host 8.8.8.8,1.1.1.1
staxping2 --interval 500
The default target is 1.1.1.1. Press q or Ctrl+C to exit.
Documentation #
- Usage and configuration — controls, hosts, checks, thresholds, history, and configuration fields.
- Architecture and platform behavior — collection, loss accounting, path discovery, reachability checks, and limitations.
- Development and releases — tests, binary packaging, release automation, and contribution boundaries.
StaxPing2 is available under the MIT licence.