Skip to content
🔎 Hunt down social media accounts by username across social networks
Python Dockerfile
Branch: master
Clone or download

Latest commit

hoadlck Merge pull request #556 from sherlock-project/site_cleanup
Fix Codechef/, Remove Brew/Canva/Fanpop/Basecamp, Update BuyMeACoffee
Latest commit e96fcf7 Feb 24, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
images renamed screenshots to images Jul 16, 2019
tests Remove timeout global and make it available on the command line. Chan… Dec 7, 2019
.dockerignore ISSUE-238 Improved build steps in Dockerfile to allow caching and imp… Jul 13, 2019
.gitignore Add an .excluded_sites list to allow pass tests Dec 5, 2019
.travis.yml Add Python 3.8 to tests. Oct 20, 2019 Add Jan 4, 2019 Update notes in contribute guide about removed sites. Add sites that … Oct 20, 2019
Dockerfile Fixed docker file, git is not included in alpine by default Dec 20, 2019
LICENSE updated license Dec 19, 2019 Update version and help text. Feb 24, 2020
data.json FIx Codechef where it would report all usernames as existing. Convert… Feb 24, 2020
data_bad_site.json Remove Basecamp. All usernames are reported as not existing. Why was … Feb 24, 2020
docker-compose.yml Use the correct name for the image Dec 4, 2019 Try to back out "Fix stray f's that break on Linux" #198. The user wa… May 15, 2019 Remove Basecamp. All usernames are reported as not existing. Why was … Feb 24, 2020
requirements.txt Use stem from PyPi insted of Git version Jan 9, 2020 Update site list and version. Feb 24, 2020 Change method used to get site ranking. Not only has change… May 28, 2019 Update site list and version. Feb 24, 2020

Hunt down social media accounts by username across social networks
Website docker image

Demo    |    Installation    |    Usage    |    Docker Notes    |    Adding New Sites


Use this link to test Sherlock directly in your browser:


NOTE: Python 3.6 or higher is required.

# clone the repo
$ git clone

# change the working directory to sherlock
$ cd sherlock

# install python3 and python3-pip if they are not installed

# install the requirements
$ python3 -m pip install -r requirements.txt

Open in Cloud Shell


$ python3 --help
usage: [-h] [--version] [--verbose] [--rank]
                   [--folderoutput FOLDEROUTPUT] [--output OUTPUT] [--tor]
                   [--unique-tor] [--csv] [--site SITE_NAME]
                   [--proxy PROXY_URL] [--json JSON_FILE]
                   [--proxy_list PROXY_LIST] [--check_proxies CHECK_PROXY]
                   [--timeout TIMEOUT] [--print-found]
                   USERNAMES [USERNAMES ...]

Sherlock: Find Usernames Across Social Networks (Version 0.10.7)

positional arguments:
  USERNAMES             One or more usernames to check with social networks.

optional arguments:
  -h, --help            show this help message and exit
  --version             Display version information and dependencies.
  --verbose, -v, -d, --debug
                        Display extra debugging information and metrics.
  --rank, -r            Present websites ordered by their global
                        rank in popularity.
                        If using multiple usernames, the output of the results
                        will be saved to this folder.
  --output OUTPUT, -o OUTPUT
                        If using single username, the output of the result
                        will be saved to this file.
  --tor, -t             Make requests over Tor; increases runtime; requires
                        Tor to be installed and in system path.
  --unique-tor, -u      Make requests over Tor with new Tor circuit after each
                        request; increases runtime; requires Tor to be
                        installed and in system path.
  --csv                 Create Comma-Separated Values (CSV) File.
  --site SITE_NAME      Limit analysis to just the listed sites. Add multiple
                        options to specify more than one site.
  --proxy PROXY_URL, -p PROXY_URL
                        Make requests over a proxy. e.g.
  --json JSON_FILE, -j JSON_FILE
                        Load data from a JSON file or an online, valid, JSON
  --proxy_list PROXY_LIST, -pl PROXY_LIST
                        Make requests over a proxy randomly chosen from a list
                        generated from a .csv file.
  --check_proxies CHECK_PROXY, -cp CHECK_PROXY
                        To be used with the '--proxy_list' parameter. The
                        script will check if the proxies supplied in the .csv
                        file are working and anonymous.Put 0 for no limit on
                        successfully checked proxies, or another number to
                        institute a limit.
  --timeout TIMEOUT     Time (in seconds) to wait for response to requests.
                        Default timeout of 60.0s.A longer timeout will be more
                        likely to get results from slow sites.On the other
                        hand, this may cause a long delay to gather all
  --print-found         Do not output sites where the username was not found.

To search for only one user:

python3 user123

To search for more than one user:

python3 user1 user2 user3

Accounts found will be stored in an individual text file with the corresponding username (e.g user123.txt).

Anaconda (Windows) Notes

If you are using Anaconda in Windows, using 'python3' might not work. Use 'python' instead.

Docker Notes

If docker is installed you can build an image and run this as a container.

docker build -t mysherlock-image .

Once the image is built, sherlock can be invoked by running the following:

docker run --rm -t mysherlock-image user123

The optional --rm flag removes the container filesystem on completion to prevent cruft build-up. See:

The optional -t flag allocates a pseudo-TTY which allows colored output. See:

Use the following command to access the saved results:

docker run --rm -t -v "$PWD/results:/opt/sherlock/results" mysherlock-image -o /opt/sherlock/results/text.txt user123

The -v "$PWD/results:/opt/sherlock/results" option tells docker to create (or use) the folder results in the present working directory and to mount it at /opt/sherlock/results on the docker container. The -o /opt/sherlock/results/text.txt option tells sherlock to output the result.

Or you can use "Docker Hub" to run sherlock:

docker run theyahya/sherlock user123

Using docker-compose

You can use the docker-compose.yml file from the repository and use this command:

docker-compose run sherlock -o /opt/sherlock/results/text.txt user123

Adding New Sites

Please look at the Wiki entry on adding new sites to understand the issues.

NOTE: Sherlock is not accepting adult sites in the standard list.


Thank you for contributing to Sherlock!

Before creating a pull request with new development, please run the tests to ensure that everything is working great. It would also be a good idea to run the tests before starting development to distinguish problems between your environment and the Sherlock software.

The following is an example of the command line to run all the tests for Sherlock. This invocation hides the progress text that Sherlock normally outputs, and instead shows the verbose output of the tests.

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

Note that we do currently have 100% test coverage. Unfortunately, some of the sites that Sherlock checks are not always reliable, so it is common to get response errors.

If some sites are failing due to conection problems (site is down, in maintainence, etc) you can exclude them from tests by creating a tests/.excluded_sites file with a list of sites to ignore (one site name per line).

Stargazers over time

Stargazers over time


MIT © Sherlock Project
Original Creator - Siddharth Dushantha

You can’t perform that action at this time.