Installation
HunterX can be installed from source or used via Docker. Choose the method that best fits your environment and use case.
Installation from Source
Follow these steps to install HunterX from source on your local machine:
- Clone the repository:
git clone https://github.com/nullc0d30/HunterX.git - Navigate to the project directory:
cd HunterX - Create and activate a virtual environment:
python -m venv venv
Linux/macOS:source venv/bin/activate
Windows:venv\Scripts\activate - Install dependencies:
pip install -r requirements.txt - Run the post-install setup:
python setup.py - Verify installation:
python hunterx.py --help
Docker Installation
HunterX is available as a Docker image for easy deployment and consistent environments.
Pull the Latest Image
docker pull nullc0d30/hunterx:latest
Run a Basic Scan
docker run --rm -v $(pwd)/reports:/data nullc0d30/hunterx:latest -u http://target.com -o /data
Replace http://target.com with your target URL and adjust the volume mount as needed.
Run with AI Analysis
docker run --rm \\ -v $(pwd)/reports:/data \\ -e OPENAI_API_KEY=sk-... \\ nullc0d30/hunterx:latest \\ -u http://target.com --ai --ai-model gpt-4 -o /data
API Mode with Persistent Reports
docker run --rm -p 8443:8443 -v $(pwd)/reports:/data \\ nullc0d30/hunterx:latest api --port 8443
Configuration
HunterX reads configuration from hunterx.yaml by default. Key configuration sections include:
AI Provider Settings
Configure API keys, model selection, and provider preferences for OpenAI, Ollama, and other supported providers.
Scan Profiles & Presets
Define operator profiles (internal, bounty, gov) and scan presets (quick, full, stealth) for different use cases.
Payload Policy
Set execution safety levels (safe, balanced, aggressive, research, paranoid) and configure the mutation engine.
Agent Configuration
Register and configure the 10 specialized AI agents for your scanning workflows.