ADscanADscan Docs

Installation

Install ADscan using pipx, pip, or download the pre-built binary

ADscan can be installed using pipx (recommended) or pip, or downloaded as a pre-built binary.

Prerequisites

  • OS: Linux (Debian/Ubuntu/Kali and other Debian-based distributions)
  • Privileges: Root access required for installation and full functionality
  • Python: 3.8+ (managed automatically if using binary)

pipx ensures ADscan runs in an isolated environment without affecting your system Python.

# Install pipx if not already installed
sudo apt install pipx
pipx ensurepath

# Install ADscan
pipx install adscan

Method 2: Install with pip

pip install adscan

Method 3: Download Pre-built Binary

Download the latest release from GitHub:

# Download latest release
wget https://github.com/ADscanPro/adscan/releases/latest/download/adscan

# Make executable
chmod +x adscan

# Move to PATH
sudo mv adscan /usr/local/bin/

Verify Installation

Check that ADscan is installed correctly:

adscan --version

You should see output like:

ADscan version 2.3.0-lite

Install Dependencies

After installing ADscan, run the installer to set up all required dependencies:

adscan install

This command will:

  • Set up the Python virtual environment
  • Install required Python packages
  • Download and configure external security tools
  • Install wordlists for password cracking
  • Launch BloodHound CE and configure it automatically

The installation process may take 5-10 minutes depending on your internet connection.

Verify Dependencies

After installation completes, verify all dependencies are correctly installed:

adscan check

This will check and report the status of:

  • Python environment
  • External tools (NetExec, BloodHound, etc.)
  • Wordlists
  • Configuration files

Next Steps

Once installation is complete, proceed to the Quick Start guide to run your first scan.

Troubleshooting

Permission Denied

If you encounter permission errors, ensure you're running with sudo:

sudo adscan install

Missing Dependencies

If some dependencies fail to install, you can retry:

adscan install --force

BloodHound Issues

If BloodHound fails to start, check Docker is installed and running:

sudo systemctl status docker

For more help, join our Discord community.