Skip to content

Quick Start Guide

Getting a local copy

First you need the ability to run docker, or if you want to work through the dependencies and build your own python app... you can do that as well. You can also clone the repo and build the docker container locally. The only recommended option is to pull down the container from github's container registry.

Please follow the recommended method, if you do not we are not responsible for something not working properly.

You NEED an options.yaml and a config.yaml - Please see the sections on customizing those before running. Ensure the options and config are in your working directory.

docker pull ghcr.io/darksidesecurity/aphids:latest 
pip install git+https://github.com/darksidesecurity/aphids.git
aphids-cli -o options.yaml -c config.yaml

Manual Docker

Currently aphids-core which is the container and python application that executes the tools is not published. In a future release, you will be able to pull down the aphids-core and build your own version of the core then pass as an argument using aphids-cli -i containername

Passing a custom container image can allow you to add additional tools and