Quickstart

August 14, 2026 · View on GitHub

This guide gets HunterX v7 installed and walks you through a first, safe, authorized mission.

Prerequisites

  • Python 3.11+
  • Linux, macOS or Windows
  • Authorization to test the target you exercise (see [Responsible Use]({{ '/responsible-use/' | relative_url }}))

Install

# PyPI install (any platform)
python -m pip install hunterxsec

# Or system install (Linux/macOS)
curl -sSL https://raw.githubusercontent.com/nullc0d30/HunterX/main/install.sh | sudo bash

# Or install the current package from source
git clone https://github.com/nullc0d30/HunterX.git
cd HunterX
python -m pip install -e ".[api,db,dev]"

Name note. The GitHub repository nullc0d30/HunterX is the canonical home of HunterX, created and maintained by Ahmed Awad (AKA NullC0d3). The HunterX v7 distribution is published to PyPI as hunterxsec; a different, unrelated Python project also uses the name hunterx on PyPI. The import package and CLI command are hunterx either way, so install with pip install hunterxsec.

Verify:

hunterx version        # HunterX v7.0.0
hunterx help           # command list
hunterx config         # resolved configuration

Run your first mission

HunterX v7 organizes work as missions (hunterx mission / hunterx hunt). HunterX drives external security tools, so first establish the base environment and check readiness, then start with an authorized target:

# Tool readiness: detect, verify and (optionally) provision external tools
hunterx install                        # base environment
hunterx tools check                    # readiness table + capability coverage
hunterx tools audit                    # integration maturity (knowledge + runtime)
hunterx tools install --profile recon  # provision missing recon tools

# Plan and start a full-spectrum hunt mission
hunterx hunt full_security_assessment https://example.com

# Track it
hunterx hunt status <mission_id>
hunterx hunt surface <mission_id>

Every hunt runs a readiness preflight before execution: required capabilities without an available tool block the mission with an explicit status: blocked (never a silent zero-execution mission); missing optional tools produce a degraded mission that still runs.

Explore the toolchain

# Inspect the registered security toolchain
hunterx tools list
hunterx tools capabilities
hunterx tools health

Manage findings and reports

hunterx finding list <mission_id>
hunterx report generate <finding_id>
hunterx report export <report_id> markdown

Next steps

  • [CLI Reference]({{ '/cli/' | relative_url }}) — every hunterx command
  • [Tool Readiness & Auto-Provisioning]({{ '/tool-readiness/' | relative_url }}) — how external tools are discovered and provisioned
  • [Configuration]({{ '/configuration/' | relative_url }}) — HUNTERX_* environment overrides
  • [AI Configuration]({{ '/configuration/ai/' | relative_url }}) — enable AI providers, API keys and models
  • [Features]({{ '/features/' | relative_url }}) — platform capabilities
  • [Documentation Hub]({{ '/documentation/' | relative_url }}) — the full v7 guide set