Installation and Build

Separate Classic and Electron + Go releases, pip, Docker, source setup, validation, and packaging commands for v4.0.4.

Installation and Build

Install Surfaces

WSHawk currently makes the most sense in four install shapes:

pip Install

pip install wshawk
playwright install chromium

Useful entry points:

  • wshawk
  • wshawk-interactive
  • wshawk-advanced
  • wshawk-defensive

Desktop from Source

Classic Electron + Python:

git clone https://github.com/regaan/wshawk
cd wshawk
git status
pip install -e .
cd desktop
npm install
npm run smoke
npm start

Electron + Go:

cd electron-desktop
npm ci
npm run build:go
npm start

Electron + Go validation:

npm run test:all
npm run test:parity
npm run test:e2e
npm run test:authorization-benchmark

Use the package command matching the host: npm run dist:win, npm run dist:linux, or npm run dist:mac.

Docker

docker pull rothackers/wshawk:latest
docker run --rm rothackers/wshawk ws://target.example/ws

Docker is useful for the compatibility CLI path. It is not the main v4 desktop experience.

Smoke Check

The Classic desktop smoke check is the lightweight sanity run for the Electron shell and Python service startup:

cd desktop
npm run smoke