Skip to content

README.md

Latest commit

 

History

History
281 lines (214 loc) · 9.49 KB

README.md

File metadata and controls

281 lines (214 loc) · 9.49 KB

ntchk - Network Toolkit

Version License PowerShell Platform Policy Friendly

A modern, lightweight, policy-friendly Windows desktop application for comprehensive network diagnostics and speed testing. Built with PowerShell and WPF, featuring a clean interface with dark mode support and automatic updates.

✅ Enterprise Ready - No VBScript dependencies, policy-compliant launchers (.exe/.bat)

Features

Speed Test

  • Powered by Ookla Speedtest CLI - Industry-standard speed testing
  • Real-time download/upload speed measurements
  • Ping, jitter, and latency metrics
  • ISP and server information
  • Export results to JSON format
  • Auto-export option for automated testing

Network Information

  • Automatic network name detection (WiFi/Ethernet)
  • Public and local IP addresses
  • Gateway and DNS server information
  • One-click refresh with timestamp
  • Clean, organized display

Diagnostics Tools

  • Ping - Test connectivity and latency to any host
  • Nslookup - DNS query and hostname resolution
  • Traceroute - Trace network path to any host
  • Port Scanner - Scan single or multiple ports on any host
  • DNS Cache Flush - Clear DNS resolver cache
  • IP Release/Renew - Refresh DHCP configuration
  • Winsock Reset - Fix network stack issues
  • ARP Cache Clear - Clear address resolution cache
  • Real-time command output display

Subnet & CIDR Calculator

  • Classful Subnet Calculator — Select Network Class (A / B / C), enter IP and subnet mask for live results
  • First Octet Range, Hex IP, Wildcard Mask, Subnet/Mask Bits, Max Subnets, Hosts per Subnet
  • Host Address Range, Subnet ID, Broadcast Address, and Subnet Bitmap (visual bit breakdown)
  • CIDR Calculator — Enter IP and prefix length (1–32) for live classless results
  • CIDR Netmask, Wildcard Mask, Total Addresses, Usable Hosts, Network Address, CIDR Notation, Address Range
  • All fields recalculate instantly on every keystroke or dropdown change — no button required
  • Full Light and Dark mode support

Settings & Customization

  • Light/Dark Mode - Toggle between themes
  • Auto-Update - Automatic update checks with one-click installation
  • Export Folder - Configure where results are saved
  • Desktop Shortcut - Create/remove desktop shortcuts
  • Ookla CLI Path - Customize speedtest.exe location
  • Clean JSON-based configuration

Auto-Update System

  • Automatic Checks - Check for updates on startup (configurable)
  • Manual Checks - Click "Check for Updates" in Settings
  • One-Click Install - Download and install updates automatically
  • Settings Preservation - Your config and exports are preserved
  • GitHub Integration - Updates pulled directly from releases

Contact & Support

  • Direct email and LinkedIn links
  • Optional donation support (Revolut QR code)
  • Professional contact popup

Installation

Option 1: Portable Release (Recommended)

  1. Download the latest ntchk-vX.X.X-Portable.zip from Releases
  2. Extract to any folder
  3. Double-click ntchk.exe (policy-friendly - RECOMMENDED) or ntchk.bat

Option 2: Clone Repository

git clone https://github.com/MadAreYou/Network_Check_app.git
cd Network_Check_app
.\ntchk.ps1

Quick Start

  1. Launch the application

    • Double-click ntchk.exe (recommended - policy-friendly, no console window)
    • Or double-click ntchk.bat (fallback option)
    • Or right-click ntchk.ps1 → "Run with PowerShell" (troubleshooting)

  2. Run a speed test

    • Click the Speed Test tab
    • Click Start Speed Test
    • Wait for results (30-60 seconds)
    • Optionally export results

  3. Check network information

    • Click the Network Info tab
    • View all network details
    • Click Refresh to update

  4. Use diagnostics tools

    • Click the Diagnostics tab
    • Select a tool (traceroute, flush DNS, etc.)
    • View real-time output

  5. Calculate subnets / CIDR

    • Click the Subnet Calc tab
    • Select Classful or CIDR mode
    • Enter IP address and subnet mask / prefix length
    • All fields update instantly

  6. Customize settings

    • Click the Settings tab
    • Configure export folder, theme, shortcuts
    • Enable/disable auto-update checks
    • Click "Check for Updates" for manual update check
    • Changes save automatically

🛡️ Enterprise & Policy Compliance

ntchk is designed to be enterprise-friendly and compliant with strict security policies:

  • ✅ No VBScript - Removed all .vbs dependencies that trigger security warnings
  • ✅ Policy-Friendly Launchers - Uses .exe (compiled .NET) and .bat (pure batch) only
  • ✅ Non-Suspicious Naming - Renamed from "Network Check" to "ntchk" to avoid security flags
  • ✅ Minimal Permissions - Runs without admin rights (except specific diagnostic tools)
  • ✅ Portable - No installation, registry changes, or system modifications
  • ✅ Transparent Code - All PowerShell source code is readable and auditable

Recommended Launch Method: Use ntchk.exe - a small compiled .NET launcher that starts PowerShell hidden. This is the most policy-compliant option.

Requirements

  • Operating System: Windows 10/11 (or Windows Server 2016+)
  • PowerShell: Version 5.1 or later (pre-installed on Windows 10/11)
  • Internet: Required for speed testing
  • Permissions: Some diagnostics require Administrator privileges

Building from Source

Build Policy-Friendly Launcher

# Navigate to build folder
cd build

# Compile ntchk.exe launcher
.\Build-Launcher.ps1

# Output: ntchk.exe (policy-friendly .NET executable)

Build Portable Release

# Navigate to build folder
cd build

# Run build script
.\Build-Portable.ps1

# Output: releases/ntchk-vX.X.X-Portable.zip

The build script automatically:

  • Creates clean temp folder
  • Copies all required files (including ntchk.exe)
  • Generates README.txt
  • Compresses to ZIP format

Customize Build

Edit build/Build-Config.json:

{
    "version": "1.0.3",
    "appName": "ntchk",
    "author": "Your Name"
}

Project Structure

ntchk/
 ntchk.exe                 # Policy-friendly .NET launcher (RECOMMENDED)
 ntchk.bat                 # Fallback BAT launcher (no VBScript)
 ntchk.ps1                 # Main application entry point
 config.json               # User configuration (auto-created on first run)
 config.default.json       # Default config template (for releases)
 speedtest.exe             # Ookla Speedtest CLI (1.2MB)
 ui/
    MainWindow.xaml       # WPF interface definition
 src/
    Settings.ps1          # Configuration management
    Export.ps1            # Result export functions
    NetworkInfo.ps1       # Network information gathering
    Diagnostics.ps1       # Diagnostic tool implementations
    SpeedTest.ps1         # Speed test execution
    SubnetCalc.ps1        # Subnet & CIDR calculator
    Update.ps1            # Auto-update functionality
 assets/
    desktop_icon.ico      # Desktop shortcut icon
    revolut_qr.png        # Donation QR code (optional)
 build/
    Build-Portable.ps1    # Portable release packager
    Build-Launcher.ps1    # Launcher compiler
    ntchk-launcher.cs     # C# launcher source
    Build-Config.json     # Build configuration
    README.md             # Build documentation
 exports/                  # Speed test results (user data)

Screenshots

Speed Test

Speed Test

Network Information

Network Info

Diagnostics Tools (including Port Scanner)

Diagnostics

Subnet & CIDR Calculator

Subnet Calc

Settings Panel

Settings

Light Mode

Light Mode

Dark Mode

Dark Mode

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -m 'Add YourFeature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.

Changelog

See CHANGELOG.md for version history and release notes.

License

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

Note: This project includes the Ookla Speedtest CLI (speedtest.exe), which is licensed separately by Ookla. See https://www.speedtest.net/apps/cli

Author

Juraj Madžunkov

Support

This app is free and open-source. If you find it useful, consider buying me a coffee!

Revolut: @jurajcy93

Acknowledgments

  • Ookla for the excellent Speedtest CLI
  • The PowerShell and WPF communities for inspiration and resources
Made with love in PowerShell