Find usernames across social networks
NOTE: Python 3.6 or higher is required.
# clone the repo
$ git clone https://github.com/TheYahya/sherlock.git
# change the working directory to sherlock
$ cd sherlock
# install python3 and python3-pip if you don't have it already
# install the requirements
$ pip3 install -r requirements.txtusage: python3 sherlock [-h] [--version] [--verbose] [--silent] [--quiet] [--tor]
[--unique-tor] [--csv] [--site SITE_NAME] [--proxy PROXY_URL]
[--output OUTPUT] [--rank] [--folderoutput FOLDEROUTPUT]
[--json JSON_FILE]
USERNAMES [USERNAMES ...]
__main__ (Version 1.0.0)
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.
--silent Do not output anything, ideally used when the output
is saved with --output or --folderoutput
--quiet, -q Disable debugging information (Default Option).
--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.
socks5://127.0.0.1:1080
--output OUTPUT, -o OUTPUT
If using single username, the output of the result
will be saved at this file.
--rank, -r Present websites ordered by their Alexa.com global
rank in popularity.
--folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUT
If using multiple usernames, the output of the results
will be saved at this folder.
--json JSON_FILE, -j JSON_FILE
Load data from a JSON file or an online, valid, JSON
file.
For example, run python sherlock user123, and all of the accounts
found will be printed on the terminal.
You can also use it within other scripts once Sherlock is registerd on PyPI as a package.
from sherlock import Sherlock
sherlock = Sherlock('user')
r = sherlock.check('facebook') # will check only facebook
if r['Facebook']['exists'] == 'yes':
# 'user' exists on Facebook
r2 = sherlock.check() # will check all supported sites
for site in r2:
if r2[site]['exists'] == 'yes':
# do whateverIf you have docker 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 mysherlock-image user123
The optional --rm flag removes the container filesystem on completion to prevent cruft build-up. See https://docs.docker.com/engine/reference/run/#clean-up---rm
One caveat is the text file that is created will only exist in the container so you will not be able to get at that.
Or you can simply use "Docker Hub" to run sherlock:
docker run theyahya/sherlock user123
If you are contributing to Sherlock, then Thank You!
Before creating a pull request with new development, please run the tests to ensure that all is well. 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
You can also use nose by running
$ nosetests tests/* -vv
Note that the tests are very much a work in progress. Significant work is required to get full test coverage. But, the current tests are working properly, and will be expanded as time goes by.
Siddharth Dushantha (sdushantha)
MIT © Yahya SayadArbabi