@usex/pingu

v1.0.5

Published

5 months ago

A modern ping utility with beautiful CLI output, real-time network analysis, and comprehensive performance metrics

0High
0Medium
0Low

ali-master

ping pingu cli network diagnostics diagnostic

🐧 PINGU

A modern ping utility with beautiful CLI output, real-time network analysis, and comprehensive performance metrics

Features • Installation • Usage • Development • Contributing

✨ Features

🎨 Beautiful Terminal UI - Built with Ink and Ink UI components
📊 Real-time Monitoring - Live ping results with animated progress indicators
🔍 Comprehensive Analysis - Detailed network quality metrics, jitter analysis, and performance scoring
📱 Responsive Design - Adapts to different terminal sizes (narrow, medium, wide layouts)
🌐 Cross-platform - Works on Windows, macOS, Linux, and OpenBSD
📁 Export Support - Save detailed analysis results to JSON files
🎯 Advanced Metrics - Packet loss, response time distribution, streak analysis, and more
⚡ Fast & Lightweight - Single binary with no dependencies

🚀 Quick Start

One-line Installation

# Install latest version for your platform (auto-detects OS/arch)
curl -fsSL https://raw.githubusercontent.com/ali-master/pingu/master/scripts/install.sh | sh

# Force reinstall/upgrade without prompts
curl -fsSL https://raw.githubusercontent.com/ali-master/pingu/master/scripts/install.sh | sh -s -- --force

Note: The installer automatically detects your operating system and CPU architecture, downloads the appropriate binary, and installs it to your system. It will try to install to /usr/local/bin (with sudo if needed) or fall back to ~/.local/bin. When run non-interactively (piped), it will automatically proceed with upgrades.

Platform-specific Downloads

macOS

# Apple Silicon (M1/M2/M3/M4)
curl -L https://github.com/ali-master/pingu/releases/latest/download/pingu-macos-arm64 -o pingu
chmod +x pingu && sudo mv pingu /usr/local/bin/

# Intel (x86_64)
curl -L https://github.com/ali-master/pingu/releases/latest/download/pingu-macos-amd64 -o pingu
chmod +x pingu && sudo mv pingu /usr/local/bin/

Linux

# x86_64 (AMD64)
curl -L https://github.com/ali-master/pingu/releases/latest/download/pingu-linux-amd64 -o pingu
chmod +x pingu && sudo mv pingu /usr/local/bin/

# ARM64 (AArch64)
curl -L https://github.com/ali-master/pingu/releases/latest/download/pingu-linux-arm64 -o pingu
chmod +x pingu && sudo mv pingu /usr/local/bin/

Windows

# x86_64 (Intel/AMD)
Invoke-WebRequest -Uri "https://github.com/ali-master/pingu/releases/latest/download/pingu-windows-amd64.exe" -OutFile "pingu.exe"

# Add to PATH (optional)
$env:PATH += ";$PWD"

🔄 Upgrading Pingu

Automatic Upgrade

# Run the installer again to upgrade to the latest version
curl -fsSL https://raw.githubusercontent.com/ali-master/pingu/master/scripts/install.sh | sh

The installer will:

Detect your existing installation
Prompt you to confirm the upgrade
Backup your current binary (with timestamp)
Install the latest version
Verify the installation

Manual Upgrade

# Check your current version
pingu --version

# Download the latest version for your platform
# (Replace with your specific platform from the examples above)
curl -L https://github.com/ali-master/pingu/releases/latest/download/pingu-linux-amd64 -o pingu-new

# Replace the existing binary
chmod +x pingu-new
sudo mv pingu-new /usr/local/bin/pingu

# Verify the upgrade
pingu --version

Version Management

# Check latest release version
curl -s https://api.github.com/repos/ali-master/pingu/releases/latest | grep tag_name

# Download a specific version (replace v1.0.0 with desired version)
curl -L https://github.com/ali-master/pingu/releases/download/v1.0.0/pingu-linux-amd64 -o pingu

From Source

# Prerequisites: Bun 1.0+
git clone https://github.com/ali-master/pingu.git
cd pingu
bun install
bun run build

# Binary will be available at ./dist/pingu

🗑️ Uninstalling Pingu

Automatic Uninstall

If you installed Pingu using the installation script, you can remove it with:

# Remove from system-wide location
sudo rm -f /usr/local/bin/pingu

# Or remove from user location
rm -f ~/.local/bin/pingu
rm -f ~/bin/pingu

# Windows users
# Remove from user directory
Remove-Item "$HOME\.pingu\pingu.exe" -Force
Remove-Item "$HOME\.pingu" -Force

Complete Uninstall

To completely remove Pingu and all related files:

# 1. Remove the binary
sudo rm -f /usr/local/bin/pingu
rm -f ~/.local/bin/pingu
rm -f ~/bin/pingu

# 2. Remove shell completions (if installed)
# Bash
rm -f ~/.local/share/bash-completion/completions/pingu
sudo rm -f /usr/local/etc/bash_completion.d/pingu

# Zsh
rm -f ~/.local/share/zsh/site-functions/_pingu

# Fish
rm -f ~/.config/fish/completions/pingu.fish

# 3. Remove any configuration files (if any)
rm -rf ~/.config/pingu
rm -rf ~/.pingu

# 4. Clean up PATH (if manually added)
# Edit your shell config file (.bashrc, .zshrc, etc.) and remove any lines containing:
# export PATH="$PATH:/path/to/pingu"

Verify Uninstallation

# Check if pingu is removed
which pingu  # Should return nothing
pingu --version  # Should return "command not found"

📖 Usage

Basic Usage

# Ping a host continuously
pingu google.com

# Ping with specific count
pingu -c 10 8.8.8.8

# Ping with custom interval and timeout
pingu --count 5 --interval 2 --timeout 10 example.com

# Export results to JSON
pingu -e --count 20 cloudflare.com

Command Line Options

Usage
  $ pingu <host>
  $ pingu completion <shell>

Options
  --count, -c       Number of ping packets to send (default: unlimited)
  --chart, -ch      Display chart (default: false)
  --display, -d     Number of ping packets to display (default: 8)
  --interval, -i    Wait interval seconds between sending each packet (default: 1)
  --timeout, -t     Time to wait for a response, in seconds (default: 5)
  --size, -s        Number of data bytes to be sent (default: 56)
  --export, -e      Export results to JSON file after completion

Commands
  completion <shell>    Generate shell completion script (bash, zsh, fish)

Examples
  $ pingu google.com
  $ pingu -c 10 8.8.8.8
  $ pingu --count 5 --interval 2 example.com
  $ pingu -e -c 100 cloudflare.com
  $ pingu completion bash > ~/.local/share/bash-completion/completions/pingu

Interface Overview

Pingu provides a comprehensive real-time interface that includes:

📡 Live Feed - Real-time ping results with status indicators
📊 Quick Statistics - Packet counts, success rates, and loss percentages
📈 Performance Overview - Success/error rate progress bars
🌐 Network Quality - Overall network quality scoring and assessment
⏱️ Response Time Analysis - Min, max, average, median, and jitter metrics
🔥 Streak Analysis - Current and historical success/failure streaks
🚨 Error Analysis - Detailed breakdown of timeout and unreachable errors
🔬 Advanced Metrics - Response time distribution and sequence analysis

🎨 Responsive Design

Pingu automatically adapts its interface based on your terminal size:

Narrow (< 60 cols): Compact layout with essential information
Medium (60-120 cols): Standard layout with most features
Wide (≥ 120 cols): Full layout with advanced metrics and dual-column displays

📊 Network Quality Metrics

Pingu analyzes your network connection and provides detailed metrics:

Network Quality Score (0-100): Overall connection quality
Jitter Analysis: Response time variability measurement
Consistency Score: Network stability assessment
Packet Loss Tracking: Real-time loss percentage calculation
Response Time Distribution: Categorized latency analysis
Streak Tracking: Success/failure pattern analysis

🐚 Shell Completions

Pingu includes built-in shell completion support for bash, zsh, and fish shells, providing intelligent tab completion for all commands and options.

Quick Setup

The installer automatically sets up completions, but you can also configure them manually:

Bash:

# Generate and install completion
pingu completion bash > ~/.local/share/bash-completion/completions/pingu

# Add to ~/.bashrc
source ~/.local/share/bash-completion/completions/pingu

Zsh:

# Generate and install completion
pingu completion zsh > ~/.local/share/zsh/site-functions/_pingu

# Add to ~/.zshrc
fpath=(~/.local/share/zsh/site-functions $fpath)
autoload -U compinit && compinit

Fish:

# Generate and install completion (auto-loaded)
pingu completion fish > ~/.config/fish/completions/pingu.fish

Completion Features

🎯 Smart option completion - Tab complete all flags and options
🔢 Value suggestions - Intelligent suggestions for numeric options (count, interval, timeout)
🌐 Hostname completion - Common hosts like google.com, 8.8.8.8, 1.1.1.1
📝 Contextual help - Descriptions for all options and commands
⚡ Subcommand support - Complete the completion command and shell types

Usage Examples

# Tab completion for options
pingu --c<TAB>          # → --count --chart
pingu --count <TAB>     # → 1 2 3 4 5 10 20 50 100

# Hostname completion
pingu goo<TAB>          # → google.com
pingu 8.<TAB>           # → 8.8.8.8

# Completion command
pingu completion <TAB>  # → bash zsh fish

🛠️ Development

Prerequisites

Bun 1.0+ (recommended) or Node.js 18+
TypeScript 5.0+

Development Setup

# Clone the repository
git clone https://github.com/ali-master/pingu.git
cd pingu

# Install dependencies
bun install

# Start development mode
bun run dev

# Type checking
bun run typecheck

# Run tests
bun run test

# Build for production
bun run build

Project Structure

pingu/
├── src/
│   ├── cli.tsx           # CLI entry point and argument parsing
│   ├── app.tsx           # Main React component with responsive UI
│   ├── analyzer.ts       # Ping output analysis logic
│   ├── types/
│   │   ├── entry.ts      # Ping entry type definitions
│   │   └── analysis-result.ts # Analysis result interface
│   └── helpers/
│       └── parse-line.ts # Ping output parsing utilities
├── assets/               # Logo designs and brand assets
├── dist/                # Compiled binary output
└── scripts/             # Build and deployment scripts

🤝 Contributing

We welcome contributions! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Areas for Contribution

🐛 Bug fixes and performance improvements
✨ New features and analysis metrics
📱 UI/UX enhancements and responsive design
🌍 Internationalization and localization
📚 Documentation improvements
🧪 Test coverage expansion

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Built with ❤️ using Ink and Ink UI
Inspired by traditional ping utilities but with modern UX principles
Special thanks to the open-source community for tools and libraries

⬆ Back to Top

Made with 🐧 by Ali Torki