Install WSHawk | WSHawk WebSocket Security

🍎

macOS

.dmg (Apple Silicon & Intel)

🪟

Windows

.exe NSIS Installer

🐧

Arch Linux

AUR Repository (yay)

�

Kali / Debian

Official APT Repository

🖥️Desktop Application

Download the latest release from GitHub. The Desktop app bundles everything — no Python installation needed.

🍎 macOS (Homebrew)

# 1. Add the WSHawk tap
brew tap regaan/tap

# 2. Install WSHawk
brew install --cask wshawk

Standalone: You can also download the .dmg directly from GitHub Releases.

🪟 Windows

# Download WSHawk-Setup-3.0.1.exe from GitHub Releases
# https://github.com/regaan/wshawk/releases/latest

# 1. Run the installer
# 2. Choose installation directory
# 3. Launch WSHawk from Start Menu or Desktop shortcut

Note: Windows SmartScreen may warn about the app. Click "More info" → "Run anyway". The app is open-source and safe.

🐧 Arch Linux (AUR)

# The easiest way to install on Arch is via the AUR
yay -S wshawk

# Alternatively, manual build from AUR:
# git clone https://aur.archlinux.org/wshawk.git
# cd wshawk && makepkg -si

� Kali / Debian / Ubuntu (APT)

# 1. Add the official WSHawk GPG key
curl -sSL https://regaan.github.io/wshawk-repo/wshawk_repo.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/wshawk-archive-keyring.gpg

# 2. Add the official Regaan APT repository
echo "deb [signed-by=/usr/share/keyrings/wshawk-archive-keyring.gpg] https://regaan.github.io/wshawk-repo stable main" | sudo tee /etc/apt/sources.list.d/wshawk.list

# 3. Install WSHawk
sudo apt update && sudo apt install wshawk

⚡CLI (pip install)

The fastest way to start scanning. Requires Python 3.8+ installed on your system.

All Platforms

# Install from PyPI
pip install wshawk

# Verify installation
wshawk --version

# Run your first scan
wshawk ws://target.com/ws

# Full scan with all features
wshawk ws://target.com/ws --full

# Launch web dashboard
wshawk --web --port 5000

Build from Source

git clone https://github.com/regaan/wshawk
cd wshawk
pip install -e .
wshawk --version

🐳Docker

Run WSHawk in an isolated container. No dependencies needed on the host.

Docker Quick Start

# Pull and run
docker pull ghcr.io/regaan/wshawk:latest
docker run --rm ghcr.io/regaan/wshawk wshawk ws://target.com/ws

# Run with web dashboard
docker run -d -p 5000:5000 \
  -e WSHAWK_WEB_PASSWORD='your-password' \
  ghcr.io/regaan/wshawk \
  wshawk --web --host 0.0.0.0

📋Quick Reference

Method	Command / Action	Best For
Homebrew (macOS)	`brew install --cask wshawk`	Best for macOS users and developers
AUR (Arch)	`yay -S wshawk`	Best for Arch Linux/Manjaro users
APT (Kali/Deb)	`apt install wshawk`	Best for Kali Linux and Debian/Ubuntu security toolkits
pip	`pip install wshawk`	CLI scanning, scripting, automation
Docker	`docker pull ghcr.io/regaan/wshawk`	CI/CD pipelines, isolated environments
Source	`git clone` + `pip install -e .`	Development, contributing, custom builds

🎬Video Tutorials

Watch step-by-step guides for installing and using WSHawk on your platform.

▶Video coming soon

Getting Started with WSHawk

Full walkthrough of scanning, interceptor, and reporting

▶Video coming soon

Install on macOS

DMG installation and Gatekeeper setup

▶Video coming soon

Install on Windows

NSIS installer walkthrough

▶Video coming soon

Install on Arch Linux

pacman package and AppImage setup

▶Video coming soon

Install on Ubuntu / Debian

deb package and AppImage setup