38 lines (28 loc) · 1.42 KB

Contributing

This is a single-script project, so contributing is intentionally lightweight.

Reporting issues

Please include:

Distro + version (cat /etc/os-release)
Where the script failed (which step/function)
Relevant lines from the per-run install log (/tmp/hexstrike-install.*.log)
Output of bash --version if it's a shell-compatibility issue

Adding a new tool to the catalogue

Tools are declared in category_tools() as binary method target lines, one category at a time. To add one:

Pick the right category (network, web, exploit, password, osint, wireless, forensics, cloud) or propose a new one.
Add a line: <binary-name> <apt|pip|go|gem|cargo> <install-target>.
If it needs Kali-only or Ubuntu-only handling, follow the existing [[ "$DISTRO" == "kali" ]] pattern used for rustscan/ghidra.
Test both the "already installed" (skip) and "missing" (install) paths if you can.

Style

Keep set -uo pipefail semantics intact — don't introduce unset-variable or unhandled-pipe-failure bugs.
Route all command output from installs through $INSTALL_LOG, not stdout, so the interactive UI stays clean.
Prefer the existing info/success/warn/err/step helpers over raw echo for anything user-facing.

Pull requests

Keep PRs focused (one tool, one bugfix, one doc update).
Describe what you tested it on (Ubuntu version / Kali, VM vs VPS vs WSL).