Go to file
Matheus Felipe 55c680fde1
fix: use star-history instead of starart.cc
resolve #2008
2024-03-15 14:50:07 -03:00
.github updated ruff syntax 2023-12-21 18:13:18 +01:00
images Updated output for finish statement 2023-02-15 21:15:54 +01:00
sherlock fix: update xlsx arg descripton (xslx -> xlsx) 2024-03-15 13:56:02 -03: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 added virtalenv files 2023-08-29 13:13:31 +02:00
CODE_OF_CONDUCT.md docs: update the code of conduct to the latest version 2022-10-02 14:07:23 +08:00
CONTRIBUTING.md Remove section regarding adult sites, as several are now included in the sites.md file. 2022-10-02 19:07:01 +01:00
Dockerfile Merge branch 'master' into patch-8 2023-03-13 11:50:52 +01:00
LICENSE updated license 2019-12-19 22:31:15 +01:00
README.md fix: use star-history instead of starart.cc 2024-03-15 14:50:07 -03:00
docker-compose.yml add WORKDIR in Dockerfile. Remove Image in compose 2020-07-21 23:52:41 +02:00
removed_sites.json removed ebio.gg 2023-12-21 17:40:24 +01:00
removed_sites.md Remove wykop.pl duplicate and fix wrong names in removed_sites.md descriptions (#2007) 2024-03-15 13:21:49 -03:00
requirements.txt added exerex 2023-03-12 22:09:49 +01:00
site_list.py mark nsfw sites as nsfw in site list 2023-02-26 11:51:56 +01:00
sites.md Remove wykop.pl duplicate and fix wrong names in removed_sites.md descriptions (#2007) 2024-03-15 13:21:49 -03:00

README.md



Hunt down social media accounts by username across social networks

Installation    |    Usage    |    Docker Notes    |    Contributing

Installation

# clone the repo
$ git clone https://github.com/sherlock-project/sherlock.git

# change the working directory to sherlock
$ cd sherlock

# install the requirements
$ python3 -m pip install -r requirements.txt

Usage

$ python3 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:

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:

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

$ cd sherlock/sherlock
$ 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

Sherlock Project Star History Chart

License

MIT © Sherlock Project
Original Creator - Siddharth Dushantha