Installation

Pre-requisites

• Python and pip already installed.
  • This has been tested with Python version 3.9 and 3.10. Earlier versions may also work. Feel free to try and log an issue letting me know if it worked or not.
• Both neo4j and bloodhound will need to be already installed. The docs at https://bloodhound.readthedocs.io/en/latest/#install explain this well.
  • If running Bloodhound with Sharphound version 4.1 you will need to add a parameter when running GoodHound to patch a minor bug in Bloodhound 4.1 see bug report.
    The parameter is detailed here.

Using Pipenv (recommended)

If you don't want to make any changes to your installed python libraries you can use pipenv:

pipenv install goodhound

Then call pipenv run to run GoodHound inside of the virtual environment just created

pipenv run goodhound -h

Using Pip

Use pip to install directly from the PyPi library:

pip install goodhound

This will create a 'goodhound' entrypoint that you can call from the CLI:

goodhound -h

Clone from GitHub

To run the raw code from GitHub:

git clone https://github.com/idnahacks/GoodHound.git
cd GoodHound
pip install -r requirements.txt
python -m goodhound -h