Installation
Get HackAgent up and running in seconds.
Quick Install
Requirements
- Python 3.10+
- pip or uv package manager
Production Installation
- uv (Recommended)
- pip
uv add hackagent
pip install hackagent
Verify Installation
After installation, verify everything works:
hackagent --version
Initial Setup
After installation, run the interactive setup wizard:
hackagent init
This will guide you through:
- 🔑 Enter your API key — Get yours at app.hackagent.dev
- 📊 Set output format — Choose between
table,json, orcsv - 🔊 Set verbosity level — Control logging detail (0=ERROR to 3=DEBUG)
- 💾 Save configuration — Stored securely for future use
Development Installation
For development or to access the latest features:
- uv (Recommended)
- pip
# Clone the repository
git clone https://github.com/AISecurityLab/hackagent.git
cd hackagent
# Install with uv
uv sync --group dev
# Clone the repository
git clone https://github.com/AISecurityLab/hackagent.git
cd hackagent
# Install in development mode
pip install -e ".[dev]"
Next Steps
- Quick Start — Get started in minutes
- Attack Tutorial — Run your first security test
- CLI Reference — Command-line interface documentation