How to Install holehe: PyPI, Source, and Docker Methods Explained
You can install holehe three ways: via pip3 install holehe for the simplest setup, by cloning the GitHub repository and running python3 setup.py install for development builds, or using Docker for isolated execution.
holehe is an asynchronous OSINT tool by megadose that checks email addresses against hundreds of websites to find registered accounts. This guide covers every installation method documented in the official repository, helping you choose the right approach for your environment.
Install holehe from PyPI (Recommended)
The fastest way to get started is installing the latest release from the Python Package Index.
pip3 install holehe
This command pulls the package and makes the holehe CLI available globally. It automatically handles all dependencies defined in setup.py【/cache/repos/github.com/megadose/holehe/master/setup.py†L1-L30】.
Verify the installation:
holehe --help
Install holehe from Source
Use this method if you need unreleased features, want to modify modules, or contribute to development.
Step 1: Clone the repository
git clone https://github.com/megadose/holehe.git
cd holehe/
Step 2: Install via setuptools
python3 setup.py install
The setup.py script orchestrates dependency resolution and registers entry points for the holehe command【/cache/repos/github.com/megadose/holehe/master/setup.py†L1-L30】.
For editable development installs (changes reflect immediately):
pip3 install -e .
Run holehe with Docker
Docker provides complete isolation from your host Python environment—ideal for security research or CI/CD pipelines.
Step 1: Build the image
docker build . -t my-holehe-image
The repository's Dockerfile packages holehe with all required dependencies【/cache/repos/github.com/megadose/holehe/master/Dockerfile†L1-L30】.
Step 2: Execute a check
docker run --rm my-holehe-image holehe test@gmail.com
The --rm flag removes the container after execution, keeping your system clean.
Verify Your Installation
After installation—regardless of method—test holehe with a sample email:
holehe alice@example.com
For programmatic use, import modules directly from the holehe.core package【/cache/repos/github.com/megadose/holehe/master/holehe/core.py†L80-L33】:
import trio
import httpx
from holehe.modules.social_media.snapchat import snapchat
async def main():
email = "alice@example.com"
out = []
client = httpx.AsyncClient()
await snapchat(email, client, out)
print(out)
await client.aclose()
trio.run(main)
This pattern appears in the README's Python example section【/cache/repos/github.com/megadose/holehe/master/README.md†L50-L70】, demonstrating how to leverage holehe's async architecture in custom scripts.
Installation Requirements
- Python 3.7+ (required for async/await syntax used throughout the codebase)
- pip3 or Docker (depending on installation method)
- Stable internet connection (holehe makes concurrent HTTP requests to target sites)
Summary
- PyPI install (
pip3 install holehe) — Fastest, best for most users - Source install (
git clone+setup.py) — Latest code, development work - Docker — Isolated execution, no host dependencies
- Entry point:
holehe.core.pycontains CLI logic and async orchestration【/cache/repos/github.com/megadose/holehe/master/holehe/core.py†L80-L33】 - Individual modules located in
holehe/modules/directory
Frequently Asked Questions
What Python version does holehe require?
holehe requires Python 3.7 or higher. The codebase uses async/await syntax and the trio concurrency library, both of which depend on modern Python features.
Can I install holehe without affecting my system Python?
Yes. Use Docker for complete isolation, or create a virtual environment before pip installation: python3 -m venv venv && source venv/bin/activate && pip3 install holehe.
Where are the installation instructions officially documented?
All three methods are documented in the project's README.md【/cache/repos/github.com/megadose/holehe/master/README.md†L22-L33】, which the maintainer updates with each release.
How do I run holehe after installing from source?
After python3 setup.py install, the holehe command should be available in your shell. If not found, check that your Python scripts directory is in your PATH or use python3 -m holehe as a fallback.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →