Installation

Option 1 - Kali

The easiest way to use theHarvester is by simply using Kali Linux.
Make sure you are you using a recent version.
From there simply type: theHarvester -h and you are good to go!

Option 2 - Pipx

To install theHarvester with pipx you do the following inside the git clone of the repo;

• sudo apt install pipx python3.12-venv(If python3.12+ is not installed)
• pipx install --python python3.12 .
• The --python is only needed if your base OS python version is lower than 3.12
• pipx ensurepath

Option 3 - Docker

theHarvester can also be run with Docker.

    $ ~ > git clone https://github.com/laramies/theHarvester 
    $ ~ > cd theHarvester
    $ ~ > docker compose up -d
    $ ~ > docker logs theHarvester

Option 4 - From Source

To get running from source, simply run these commands and you are all set!
Make sure you have have UV installed which you can get from here

    $ ~ > git clone https://github.com/laramies/theHarvester 
    $ ~ > cd theHarvester

    If developing do:
        $ ~ > uv venv; source .venv/bin/activate; uv pip install ".[dev]"
    Else:
        $ ~ > uv sync; source .venv/bin/activate

    $ ~ > uv run theHarvester.py -h 

API Keys

If you wish to use api keys make sure to edit api-keys.yaml

Path to config :

• On OSX : /usr/local/etc/theharvester/

Modules that require API keys

The api-keys.yml file if installed using the setup.py or in kali are under /etc/theHarvester else it is in the root directory if you have git cloned.

• bevigil - Free upto 50 queries. Pricing can be found here: https://bevigil.com/pricing/osint
• binaryedge - $10/month
• bing
• bufferoverun - uses the free api
• censys - API keys are required and can be retrieved from your Censys account.
• criminalip
• fullhunt
• github
• hunter - limited to 10 on the free plan, so you will need to do -l 10 switch
• hunterhow
• netlas - $
• intelx
• pentesttools - $
• projecdiscovery - invite only for now
• rocketreach - $
• securityTrails
• shodan - $
• zoomeye