Skip to content

Installation and setup

  • Python 3.11 or newer.
  • Git for development checkouts and optional library updates.
  • Node.js only for dashboard development, the P4RS3LT0NGV3 bridge, or this documentation site.
  • Explicit authorization for every target.
Terminal window
python -m pip install wallbreaker-hermes==0.3.1
wallbreaker --help
wallbreaker check

The distribution is named wallbreaker-hermes. The import package and commands remain wallbreaker and wb for upstream compatibility.

Terminal window
git clone https://github.com/Yivas/wallbreaker-hermes.git
cd wallbreaker-hermes
python -m venv .venv
. .venv/bin/activate
python -m pip install -e ".[dev]"
pytest -q

On Windows PowerShell, activate with:

Terminal window
.\.venv\Scripts\Activate.ps1

Dashboard contributors use the lockfile rather than updating dependencies during setup:

Terminal window
python -m pip install -e ".[dev,dashboard]"
cd wallbreaker/dashboard/web
npm ci
npm test -- --run
npm run build
Terminal window
wallbreaker check
python -m ruff check .
pytest -q

The default suite must not require provider credentials or run a live campaign.