Sherlock - search username across all social media [BETA]
No credit card required
Sherlock - search username across all social media [BETA]
No credit card required
π Hunt down social media accounts by username across social networks https://github.com/sherlock-project/sherlock
Hunt down social media accounts by username across social networks
Installation Β Β Β |Β Β Β Usage Β Β Β |Β Β Β Docker Notes Β Β Β |Β Β Β Contributing
Installation
1# clone the repo 2$ git clone https://github.com/sherlock-project/sherlock.git 3 4# change the working directory to sherlock 5$ cd sherlock 6 7# install the requirements 8$ python3 -m pip install -r requirements.txt
Usage
1$ python3 sherlock --help 2usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT] 3 [--output OUTPUT] [--tor] [--unique-tor] [--csv] [--xlsx] 4 [--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE] 5 [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color] 6 [--browse] [--local] [--nsfw] 7 USERNAMES [USERNAMES ...] 8 9Sherlock: Find Usernames Across Social Networks (Version 0.14.3) 10 11positional arguments: 12 USERNAMES One or more usernames to check with social networks. 13 Check similar usernames using {?} (replace to '_', '-', '.'). 14 15optional arguments: 16 -h, --help show this help message and exit 17 --version Display version information and dependencies. 18 --verbose, -v, -d, --debug 19 Display extra debugging information and metrics. 20 --folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUT 21 If using multiple usernames, the output of the results will be 22 saved to this folder. 23 --output OUTPUT, -o OUTPUT 24 If using single username, the output of the result will be saved 25 to this file. 26 --tor, -t Make requests over Tor; increases runtime; requires Tor to be 27 installed and in system path. 28 --unique-tor, -u Make requests over Tor with new Tor circuit after each request; 29 increases runtime; requires Tor to be installed and in system 30 path. 31 --csv Create Comma-Separated Values (CSV) File. 32 --xlsx Create the standard file for the modern Microsoft Excel 33 spreadsheet (xlsx). 34 --site SITE_NAME Limit analysis to just the listed sites. Add multiple options to 35 specify more than one site. 36 --proxy PROXY_URL, -p PROXY_URL 37 Make requests over a proxy. e.g. socks5://127.0.0.1:1080 38 --json JSON_FILE, -j JSON_FILE 39 Load data from a JSON file or an online, valid, JSON file. 40 --timeout TIMEOUT Time (in seconds) to wait for response to requests (Default: 60) 41 --print-all Output sites where the username was not found. 42 --print-found Output sites where the username was found. 43 --no-color Don't color terminal output 44 --browse, -b Browse to all results on default browser. 45 --local, -l Force the use of the local data.json file. 46 --nsfw Include checking of NSFW sites from default list.
To search for only one user:
python3 sherlock user123
To search for more than one user:
python3 sherlock 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
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
Docker is instructed to create (or use) the folder results
in the current working directory and to mount it at /opt/sherlock/results
on the docker container by using the -v "$PWD/results:/opt/sherlock/results"
options. Sherlock
is instructed to export the result using the -o /opt/sherlock/results/text.txt
option.
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
Contributing
We would love to have you help us with the development of Sherlock. Each and every contribution is greatly valued!
Here are some things we would appreciate your help on:
- Addition of new site support ΒΉ
- Bringing back site support of sites that have been removed in the past due to false positives
[1] Please look at the Wiki entry on adding new sites to understand the issues.
Tests
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.
1$ cd sherlock/sherlock 2$ python3 -m unittest tests.all --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 problems. Any problems in connection will show up as warnings in the tests instead of true errors.
If some sites are failing due to connection problems (site is down, in maintenance, 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).
Star History
License
MIT Β© Sherlock Project
Original Creator - Siddharth Dushantha
Actor Metrics
58 monthly users
-
9 stars
98% runs succeeded
0.47 hours response time
Created in Apr 2024
Modified 7 months ago