aa1bc3c186
+ Updated description of project + Added common issues during installation process |
||
---|---|---|
.github | ||
devel | ||
docs | ||
sherlock_project | ||
tests | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
pyproject.toml | ||
pytest.ini | ||
tox.ini |
Sherlock hunts down social media accounts by username across 400+ social networks. By entering a username, Sherlock searches across popular websites and returns any accounts with matching usernames. It's an essential tool for situations such as personal investigations, security checks, or ensuring your brand’s unique identity across various platforms.
Installation • Usage • Contributing
Installation
Command | Notes | |
---|---|---|
PyPI | pipx install sherlock-project |
pip may be used in place of pipx |
Docker | docker pull sherlock/sherlock |
|
Debian family | apt install sherlock |
Kali, Parrot, Debian Testing and Sid |
BlackArch | pacman -S sherlock |
|
Homebrew | brew install sherlock |
See all alternative installation methods here
Common Installation Issues
-
'pip' command not found
- Solution: Make sure that
pip
is installed with Python. You can installpip
by following these instructions:- On Linux/macOS:
sudo apt-get install python3-pip
- On Windows: Download and install
pip
from the official pip website.
- On Linux/macOS:
- Solution: Make sure that
-
Permission Denied on Linux/macOS
- Solution: You may need to run the installation commands with
sudo
to give administrative privileges. Use the following command:sudo pip install sherlock-project
- Solution: You may need to run the installation commands with
-
Outdated
pip
Version- Solution: Upgrade
pip
to the latest version using the following command:pip install --upgrade pip
- Solution: Upgrade
-
Outdated Python Version
- Solution: Update Python version using the following command:
sudo apt-get install python3
- Solution: Update Python version using the following command:
-
Firewall or Antivirus Blocking Access
- Solution: Ensure that your firewall or antivirus settings allow Docker and Python installations to proceed without interruption.
Usage
To search for only one user:
sherlock user123
To search for more than one user:
sherlock user1 user2 user3
Accounts found will be stored in an individual text file with the corresponding username (e.g user123.txt
).
$ sherlock --help
usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]
[--output OUTPUT] [--tor] [--unique-tor] [--csv] [--xlsx]
[--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE]
[--timeout TIMEOUT] [--print-all] [--print-found] [--no-color]
[--browse] [--local] [--nsfw]
USERNAMES [USERNAMES ...]
Sherlock: Find Usernames Across Social Networks (Version 0.14.3)
positional arguments:
USERNAMES One or more usernames to check with social networks.
Check similar usernames using {?} (replace to '_', '-', '.').
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.
--folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUT
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.
--xlsx Create the standard file for the modern Microsoft Excel
spreadsheet (xlsx).
--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
--json JSON_FILE, -j JSON_FILE
Load data from a JSON file or an online, valid, JSON file.
--timeout TIMEOUT Time (in seconds) to wait for response to requests (Default: 60)
--print-all Output sites where the username was not found.
--print-found Output sites where the username was found.
--no-color Don't color terminal output
--browse, -b Browse to all results on default browser.
--local, -l Force the use of the local data.json file.
--nsfw Include checking of NSFW sites from default list.
Credits
Thank you to everyone who has contributed to Sherlock! ❤️
License
MIT © Sherlock Project
Original Creator - Siddharth Dushantha