Documentation / SwarmHack

Installation

Installation

npm (primary distribution)

npm install -g swarmhack-cli

The npm package ships a Node.js shim at bin/swarmhack.js plus a scripts/postinstall.js that resolves a platform-native binary into native/. Declared engines.node >= 16.0.0.

| Platform | Architecture |

| --- | --- |

| linux, darwin, win32 | x64, arm64 |

Bundled default config: release/npm/config/swarmhack.yaml (installed under the npm global root; resolved by the binary at runtime when no --config is passed).

Cargo (developer / contributor build)

git clone https://github.com/prancer-io/swarmhack
cd swarmhack
cargo build --release
./target/release/swarmhack --version

Cargo.toml declares edition = "2021". TLS is rustls, crypto is RustCrypto — no MIT krb5 or system OpenSSL by default.

Optional features

| Feature | Default | What it adds |

| --- | --- | --- |

| xss-modular | on | Modular XSS architecture (Phase 6). |

| self-learning | off | SONA self-learning integration (ruvector-sona). |

| headless-browser | off | chromiumoxide backend for JS-driven SPA crawl. Auto-fetches Chromium or honours CHROME_PATH. |

| kerberos-http | off | Kerberos Negotiate over HTTP via cross-krb5. Requires MIT krb5 / Heimdal libs. |

| ad-integration, ad-heavy, goad-live, goad-fixtures | off | Live AD / Samba ADDC / KDC / MSSQL fixtures. |

Verifying the install

swarmhack --version       # Prints "SwarmHack v2.6.0" + component banner
swarmhack doctor          # Component-level health check
swarmhack tools doctor    # Tier-1 / Tier-2 / Tier-3 toolchain inventory

First-time setup

1. Create a Prancer Portal account; copy the 32-character hex access token from *Settings → Access Tokens*. The customer ID must be the lowercase tenant slug (e.g. xforia, not XFORIA). 2. Write the per-engagement authorization document (see Authorization Model) to disk. 3. Drop credentials and authz-doc paths into a .env file or shell exports; never commit either to source control.