Sherlock - Honour Usernames Across Social Networks

Find usernames across social networks

Installation
NOTE: Python 3.6 or higher is required.

# clone the repo $ git clone https://github.com/sherlock-project/sherlock.git  # alter the working directory to sherlock $ cd sherlock  # install python3 together with python3-pip if non be  # install the requirements $ pip3 install -r requirements.txt

Usage

$ python3 sherlock.py --help usage: sherlock.py [-h] [--version] [--verbose] [--rank]                    [--folderoutput FOLDEROUTPUT] [--output OUTPUT] [--tor]                    [--unique-tor] [--csv] [--site SITE_NAME]                    [--proxy PROXY_URL] [--json JSON_FILE]                    USERNAMES [USERNAMES ...]  Sherlock: Find Usernames Across Social Networks (Version 0.6.4)  positional arguments:   USERNAMES             One or to a greater extent than usernames to depository fiscal establishment jibe amongst social networks.  optional arguments:   -h, --help            demonstrate this assistance message together with drib dead   --version             Display version information together with dependencies.   --verbose, -v, -d, --debug                         Display extra debugging information    together with metrics.   --rank, -r            Present websites ordered past times their Alexa.com global                         rank inward popularity.   --folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUT                         If using multiple usernames, the output of the results                         volition live on saved at this folder.   --output OUTPUT, -o OUTPUT                         If using unmarried username, the output of the effect                         volition live on saved at this file.   --tor, -t             Make requests over TOR; increases runtime; requires                         TOR to live on installed together with inward organization path.   --unique-tor, -u      Make requests over TOR amongst novel TOR circuit later each                         request; increases runtime; requires TOR to live on                         installed together with inward organization path.   --csv                 Create Comma-Separated Values (CSV) File.   --site SITE_NAME      Limit analysis to precisely the listed sites. Add multiple                         options to specify to a greater extent than than 1 site.   --proxy PROXY_URL, -p PROXY_URL                         Make requests over a proxy. e.g.                         socks5://127.0.0.1:1080   --json JSON_FILE, -j JSON_FILE                         Load information from a JSON file or an online, valid, JSON                         file.   --print-found    Prints exclusively flora messages. Errors, together with invalid    username errors volition non appear.

For example, run python3 sherlock.py user123, together with all of the accounts flora volition live on stored inward a text file amongst the username (e.g user123.txt).

Docker Notes
If yous bring docker installed yous tin displace cook an icon together with run this every bit a container.

docker cook -t mysherlock-image .

Once the icon is built sherlock tin displace live on invoked past times running the following:

docker run --rm mysherlock-image user123

The optional --rm flag removes the container filesystem on completion to foreclose cruft build-up. See https://docs.docker.com/engine/reference/run/#clean-up---rm
One caveat is the text file that is created volition exclusively be inward the container hence yous volition non live on able to become at that.
Or yous tin displace only role "Docker Hub" to run sherlock:

docker run theyahya/sherlock user123

Adding New Sites
Please await at the Wiki entry on adding novel sites to empathize the issues.

Tests
If yous are contributing to Sherlock, together with hence Thank You!
Before creating a delineate asking amongst novel development, delight run the tests to ensure that all is well. It would likewise live on a proficient thought to run the tests earlier starting evolution to distinguish problems betwixt your surroundings together with the Sherlock software.
The next is an instance of the command line to run all the tests for Sherlock. This invocation hides the progress text that Sherlock unremarkably outputs, together with instead shows the verbose output of the tests.

$ python3 -m unittest tests.all --buffer --verbose

Note that nosotros create currently bring 100% testify coverage. Unfortunately, about of the sites that Sherlock checks are non ever reliable, hence it is non uncommon to become answer errors.

Download Sherlock