Powered by SnapDock Rendering

StaxPing Documentation

StaxPing

StaxPing is a lightweight, cross‑platform network diagnostic tool that unifies DNS lookup, ICMP ping, HTTP health checks, and optional traceroute into one clean, predictable command.

Built in Rust for speed, safety, and portability — StaxPing replaces the inconsistent mix of ping, dig, curl, and traceroute with a single, reliable workflow.


🔎 1. Overview

  • What StaxPing is
  • What problems it solves
  • Supported platforms
  • High‑level features
  • Philosophy (clean, predictable, unified diagnostics)

💾 2. Installation

  • Linux .deb
  • Linux AppImage
  • Windows .exe (when available)
  • Manual build from source
  • First‑run behavior (EULA, config, capability checks)

3. Usage

  • Basic commands
  • DNS lookup
  • ICMP ping
  • HTTP health check
  • Traceroute
  • Combined diagnostics
  • Exit codes
  • Output formatting

🧩 4. Flags & Options

  • --trace
  • --advanced (reserved)
  • --help
  • Future flags
  • Examples for each

🛠️ 5. Modules Explained

Break down each subsystem:

  • DNS module
  • ICMP module
  • HTTP module
  • Traceroute module
  • Capability detection
  • Config system

⚙️ 6. Config & First‑Run Behavior

  • Where config is stored
  • What’s inside it
  • How to reset it
  • How capability detection works
  • OS‑specific notes

📤 7. Output Reference

Examples of:

  • DNS output
  • Ping output
  • HTTP output
  • Traceroute output
  • Combined output
  • Error messages
  • Fallback messages (e.g., traceroute not supported)

🧯 8. Troubleshooting

  • Permission issues
  • Missing capabilities
  • Windows ICMP quirks
  • Linux raw socket requirements
  • Network restrictions
  • DNS failures
  • HTTP timeouts

🗺️ 9. Roadmap

  • Advanced flags
  • Extended diagnostics
  • APT repo
  • Windows distribution
  • Plugin system (if ever)
  • Long‑term vision

📜 10. License & Project Status

  • Source‑available
  • Noncommercial
  • How to request commercial use
  • Link to LICENSE and EULA