NetScan Documentation

Network Intelligence Suite - CLI and Desktop GUI for network discovery, security auditing, and device management.

Downloads

macOS

Desktop GUI with optional CLI

Download .pkg

Windows

Desktop GUI installer

Download .exe

CLI Only

Command-line tools

macOS .pkg
πŸ”

MAC Vendor Lookup

Instantly identify device manufacturers from MAC addresses with local caching for speed.

πŸ“‘

Network Scanning

Discover all devices on your network using multiple scan methods (ARP, ping, TCP).

οΏ½

Device Fingerprinting

Automatically identify device types: routers, phones, laptops, IoT, printers, and more.

πŸ—ΊοΈ

Network Topology

Visualize your network as ASCII art, interactive HTML, or DOT/Graphviz diagrams.

πŸ”’

Security Audit

Scan for vulnerabilities, risky open ports, and SSL issues with actionable reports.

⏰

Scheduled Scans

Automate network monitoring with cron (Linux) or launchd (macOS) integration.

⚑

Wake-on-LAN

Wake sleeping devices remotely with magic packets and saved favorites.

πŸ‘οΈ

Real-time Monitoring

Track devices with desktop notifications on macOS, Linux, and Windows.

πŸ“Š

Reports & Export

Generate PDF, HTML, CSV, JSON reports. Beautiful styled exports.

🌐

Web Interface

Modern web dashboard for visual network management and REST API.

πŸš€

High Performance

Optional Rust module for 10-100x faster processing on large networks.

🐳

Docker Ready

Run in containers with Docker Compose. Cross-platform deployment.

Quick Installation

Install NetScan with a single command:

bash
curl -fsSL https://raw.githubusercontent.com/G1A1B1E/NetScan/main/install.sh | bash

Or install for current user only (no sudo required):

bash <(curl -fsSL https://raw.githubusercontent.com/G1A1B1E/NetScan/main/install.sh) --local
πŸ“¦ What gets installed:
  • NetScan command-line tool
  • Python helper scripts
  • Required dependencies (via Homebrew/apt)
  • OUI vendor database

Quick Start

Interactive Mode

netscan

Launch the interactive menu for guided operation.

MAC Vendor Lookup

# Single MAC address
netscan -l 00:11:22:33:44:55

# Multiple addresses
netscan -l "00:11:22:33:44:55 AA:BB:CC:DD:EE:FF"

# From file
netscan -f mac_addresses.txt

Network Scanning

# Scan local network
netscan -s

# Scan specific subnet
netscan -s 192.168.1.0/24

# Quick scan (ping only)
netscan -s --quick

Web Interface

# Start web server
netscan -w

# Custom port
netscan -w --port 9000

System Requirements

Operating System

  • macOS 10.15+
  • Linux (Ubuntu 18.04+, Debian 10+, Fedora, Arch)
  • Windows via WSL2

Required

  • Bash 4.0+
  • Python 3.7+
  • Network access

Optional

  • nmap (enhanced scanning)
  • arp-scan (ARP discovery)
  • Rust (performance module)

Next Steps