diff --git a/README.md b/README.md index f5f186c..4f16067 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ A threading management application that allows controlled execution of multiple # Contributions Contributions to this project are very welcome. If you're a newcomer to open source and would like some help in doing so, feel free to reach out to me on twitter ([@codingo_](https://twitter.com/codingo_)) and I'll assist wherever I can. +# Setup +Install using: + +```bash +$ python3 setup.py install +``` +Dependencies will then be installed and Interlace will be added to your path as `interlace`. + # Usage | Argument | Description | @@ -36,6 +44,25 @@ The following varaibles will be replaced in commands at runtime: | \_realport\_ | Replaced with the real port variable from interlace | # Usage Examples +## Run Nikto Over Multiple Sites +Let's assume that you had a file `targets.txt` that had the following contents: + +``` +bugcrowd.com +hackerone.com +``` +You could use interlace to run over any number of targets within this file using: +bash +``` +➜ /tmp interlace -tL ./targets.txt -threads 5 -c "nikto --host _target_ > ./_target_-nikto.txt" -v +============================================== +Interlace v1.0 by Michael Skelton (@codingo_) +============================================== +[14:33:23] [VERBOSE] [nikto --host hackerone.com > ./hackerone.com-nikto.txt] Added to Queue +[14:33:23] [VERBOSE] [nikto --host bugcrowd.com > ./bugcrowd.com-nikto.txt] Added to Queue +``` +This would run nikto over each host and save to a file for each target. Note that in the above example since we're using the `>` operator so results won't be fed back to the terminal, however this is desired functionality as otherwise we wouldn't be able to attribute which target Nikto results were returning for. + ## CIDR notation with an application that doesn't support it Interlace automatically expands CIDR notation when starting threads (unless the --no-cidr flag is passed). This allows you to pass CIDR notation to a variety of applications: