🔎 Hunt down social media accounts by username across social networks
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
Paul Pfeister 379725e796
Refresh documentation
7 months ago
.github Add ruff to pr tests (#2093) 7 months ago
docs Refresh documentation 7 months ago
images Updated output for finish statement 2 years ago
sherlock Updated Site List 7 months ago
.dockerignore Merge pull request #202 from nstapelbroek/ignore-venv-in-docker 5 years ago
.editorconfig chore: update editorconfig 3 years ago
.gitignore Prepare PyProject 7 months ago
Dockerfile Make an actual package with pyproject.toml 9 months ago
LICENSE updated license 5 years ago
docker-compose.yml add WORKDIR in Dockerfile. Remove Image in compose 4 years ago
pyproject.toml Build the package along with the data file for local use (#2118) 7 months ago
removed_sites.json Restore SteamID 7 months ago
removed_sites.md Remove ~correct~ Steam from Removed_Sites 7 months ago
requirements.txt added exerex 2 years ago
setup.cfg Prepare PyProject 7 months ago
site_list.py Swap try-catch for better .pop 7 months ago
sites.md Updated Site List 7 months ago

docs/README.md



Hunt down social media accounts by username across 400+ social networks

Installation    |    Usage    |    Docker    |    Contributing

Installation

PyPI - Version Docker Image Version homebrew version

Method Command Notes
pypi pipx install sherlock-project pip may be used in place of pipx
brew brew install sherlock Community supported
docker docker pull sherlock/sherlock

Alternative guides and methods

Usage

$ 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.

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).

How to contribute to Sherlock

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:

Head over to our Contributing page for additional info.

Star History

Sherlock Project Star History Chart

License

MIT © Sherlock Project
Original Creator - Siddharth Dushantha