Documentation / SwarmHack
File Map & Support
File and Directory Map
swarmhack/
├── bin/swarmhack # native binary (after npm install -g)
├── target/release/swarmhack # binary built from source (cargo build --release)
├── reports/ # OCSF JSON, HTML attack path, DOT graph, SSE MD
│ └── per-target/ # per-target outputs in multi-target campaigns
├── logs/ # rotated JSONL logs ({session-uuid}.jsonl)
├── config/
│ ├── swarmhack.yaml # top-level runtime config
│ ├── swarmhack.example.yaml # annotated example
│ ├── swarmhack.schema.json # JSON Schema (config validate)
│ ├── pentest_rate_limited.yaml # conservative rate-limit profile
│ └── sse_capability_map.yaml # SSE capability map for upsell + delta
├── lab/sse-lab/ # local SSE validation lab (docker compose)
├── tests/ # in-source regression tests
├── release/npm/ # npm package source (README, bin, config, scripts)
└── docs/
├── reference/swarmhack.md # this document
├── whitepapers/exploit-validated-sse-assessment.md
└── adr/ # architecture decision records
Versioning, Support & Links
- Source binary version:
2.6.0(Cargo.toml). - npm package version:
[email protected](release/npm/package.json). - Mission id format (useful for support tickets):
mission-YYYYMMDD-HHMMSS-<8-char-hex>. - Support: [email protected]
- Whitepaper (narrative + SSE-assessment workflow):
docs/whitepapers/exploit-validated-sse-assessment.md - npm README (introductory):
release/npm/README.md - SSE lab README:
lab/sse-lab/README.md - Prancer Terms: <https://www.prancer.io/terms-and-conditions>
- Prancer Privacy: <https://www.prancer.io/privacy-policy>
- Prancer Portal (token issuance): <https://portal.prancer.io>