Powered by SnapDock Rendering

StaxPing — Usage

← Back to StaxPing Index

Usage

StaxPing provides a unified interface for DNS lookup, ICMP ping, HTTP health checks, and optional traceroute.
This page covers the core commands, examples, and output behavior.


Basic Command

The simplest way to run StaxPing is to provide a target domain or IP:

staxping example.com

This performs:

  • DNS resolution
  • ICMP ping
  • HTTP health check

Traceroute is optional and must be enabled manually.


DNS Lookup

StaxPing automatically resolves both IPv4 and IPv6 records.

Example:

staxping example.com

DNS output includes:

  • A/AAAA records
  • Resolution time
  • Clean formatting for multiple results

If DNS resolution fails, StaxPing provides a clear fallback message.


ICMP Ping

ICMP ping runs after DNS resolution (unless disabled by capability checks).

Output includes:

  • min/avg/max latency
  • packet loss
  • jitter‑friendly timing
  • clear failure messages if ICMP is restricted

Example:

staxping 8.8.8.8

If ICMP is unavailable on the system, StaxPing reports this without exiting unexpectedly.


HTTP Health Check

StaxPing performs a lightweight HTTP request to test reachability and response behavior.

Output includes:

  • status code
  • response time
  • final URL after redirects
  • error messages for timeouts or failures

Example:

staxping https://example.com

The HTTP check is designed to be fast and safe, with no large downloads.


Traceroute

Traceroute is optional and must be enabled with --trace.

Example:

staxping example.com --trace

Traceroute output includes:

  • hop number
  • IP address
  • latency per hop
  • clean alignment for readability

If traceroute is not supported on the system, StaxPing provides a clear fallback message.


Combined Diagnostics

StaxPing is designed to run multiple diagnostics in a single command.

Example:

staxping google.com --trace

This performs:

  1. DNS lookup
  2. ICMP ping
  3. HTTP health check
  4. Traceroute

All results are displayed in a consistent, structured format.


Exit Codes

StaxPing uses predictable exit codes for scripting and automation:

  • 0 — Success
  • 1 — DNS failure
  • 2 — ICMP failure
  • 3 — HTTP failure
  • 4 — Traceroute failure
  • 5 — Capability or configuration error

If multiple modules fail, StaxPing returns the highest relevant code.


Output Formatting

StaxPing output is designed to be:

  • human‑readable
  • script‑friendly
  • aligned and consistent
  • stable across platforms

Formatting goals:

  • predictable spacing
  • clear section headers
  • no ambiguous symbols
  • clean fallback messages

This ensures StaxPing behaves the same on every supported system.


StaxPing aims to provide a clean, unified diagnostic workflow with predictable output and minimal surprises.