Go to file
Siddharth Dushantha 0ecb496ae9
Merge pull request #2125 from ppfeister/feature/codeowners
Add LICENSE
2024-05-15 20:19:38 +00:00
.github Merge pull request #2125 from ppfeister/feature/codeowners 2024-05-15 20:19:38 +00:00
docs Merge pull request #2119 from ppfeister/feature/docu 2024-05-15 19:23:54 +00:00
images Updated output for finish statement 2023-02-15 21:15:54 +01:00
sherlock Fix #2113 2024-05-13 22:47:53 -04:00
.dockerignore Merge pull request #202 from nstapelbroek/ignore-venv-in-docker 2020-06-20 22:07:02 +02:00
.editorconfig chore: update editorconfig 2021-12-07 13:07:00 +01:00
.gitignore Prepare PyProject 2024-05-11 18:21:51 +02: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
docker-compose.yml add WORKDIR in Dockerfile. Remove Image in compose 2020-07-21 23:52:41 +02:00
pyproject.toml Prepare PyProject for PyPI 2024-05-13 00:19:07 -04:00
removed_sites.json Restore SteamID 2024-05-07 00:31:57 -04:00
removed_sites.md Remove ~correct~ Steam from Removed_Sites 2024-05-07 02:00:49 -04:00
requirements.txt Prepare rpm spec 2024-05-11 23:07:57 -04:00
setup.cfg Prepare PyProject 2024-05-11 18:21:51 +02:00
setup.py Prepare rpm spec 2024-05-11 23:07:57 -04:00
sherlock-project.spec Fix manpage 2024-05-14 03:37:34 -04:00
site_list.py Swap try-catch for better .pop 2024-05-08 00:08:45 -04:00
sites.md Updated Site List 2024-05-07 18:25:51 +00:00

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