Install WSHawk
Desktop is the main v4 workflow. CLI, source, and Docker remain useful for compatibility, automation, and local development.
🪟
Windows
Desktop release asset from GitHub Releases
🍎
macOS
Desktop release asset from GitHub Releases
🐧
Linux
Desktop release asset or source build
🐳
CLI / Docker
Compatibility and automation workflows
🖥️Desktop Application
The desktop app is the strongest v4 operator surface. Download the current platform build from GitHub Releases and use the asset that matches your OS.
Download from GitHub Releases
# Latest release assets
https://github.com/regaan/wshawk/releases/latest
# Pick the package that matches your platform.
# If your OS warns on first launch, use the platform's standard
# "Open anyway" or "Run anyway" flow for unsigned open-source apps.Desktop smoke check from source
git clone https://github.com/regaan/wshawk
cd wshawk/desktop
npm install
npm run smokeNote:
npm run smoke is the lightweight desktop sanity check, not the heavier full headless path.⚡CLI via pip
The CLI still works well for a first pass, scripting, and compatibility workflows.
PyPI install
pip install wshawk
# Optional browser runtime for evidence collection
playwright install chromium
# Basic compatibility scan
wshawk ws://target.example/ws
# Interactive and advanced entry points
wshawk-interactive
wshawk-advanced ws://target.example/ws
wshawk-defensive🧰Build from Source
Use this path if you want the full local development workflow, validation labs, and desktop source tree.
Repository setup
git clone https://github.com/regaan/wshawk
cd wshawk
pip install -e .
# Optional validation check
./venv/bin/python validation/run_validation.py
# Start desktop from source
cd desktop
npm install
npm start🐳Docker
Docker is useful for isolated CLI-style execution. It is not the primary v4 desktop workflow.
Container quick start
docker pull rothackers/wshawk:latest
docker run --rm rothackers/wshawk ws://target.example/ws📋Quick Reference
| Method | Command / Action | Best For |
|---|---|---|
| Desktop | GitHub Releases | Full v4 replay, AuthZ diff, race, browser pairing, evidence |
| pip | pip install wshawk | Compatibility CLI, scripting, quick first pass |
| Source | git clone https://github.com/regaan/wshawk | Desktop development, labs, validation, smoke checks |
| Docker | docker pull rothackers/wshawk:latest | Isolated CLI-style execution |