No description
Find a file
Paul Pfeister cf7032dd99
Symlink to new manifest location
Clients that aren't yet updated will still rely on this location after
the move, and will fail unexpectedly. Symlink allows existing clients to
function as otherwise expected until they finally update.
2024-07-08 04:20:58 -04:00
.github Swap yaml wildcard for workflow 2024-06-24 16:15:12 -04:00
devel Minor lint 2024-06-24 15:42:08 -04:00
docs Rename importable module 2024-06-24 16:40:03 -04:00
sherlock/resources Symlink to new manifest location 2024-07-08 04:20:58 -04:00
sherlock_project Rename importable module 2024-06-24 16:40:03 -04:00
tests Adjust ci paths 2024-06-24 17:04:50 -04:00
.dockerignore Updated paths based on changes in c065cbb92b 2024-05-24 21:20:56 +02:00
.editorconfig chore: update editorconfig 2021-12-07 13:07:00 +01:00
.gitignore Ignore test files 2024-06-24 15:21:15 -04:00
Dockerfile Make an actual package with pyproject.toml 2024-03-02 13:21:32 -08:00
LICENSE updated license 2019-12-19 22:31:15 +01:00
pyproject.toml Rename importable module 2024-06-24 16:40:03 -04:00
pytest.ini Add newline 2024-06-02 02:19:39 -04:00
tox.ini Adjust ci paths 2024-06-24 17:04:50 -04:00



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

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

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! ❤️

Sherlock Project Star History Chart

License

MIT © Sherlock Project
Original Creator - Siddharth Dushantha