mirror of https://github.com/sherlock-project/sherlock synced 2024-11-22 03:43:02 +00:00

No description

Find a file

Czechball 8072d79d13 Added asciinema demo		2019-01-09 01:34:11 +01:00
screenshot	Organize image directory => screenshot.	2019-01-03 17:50:48 +08:00
.dockerignore	Adding docker support	2018-12-31 14:53:27 -06:00
.gitignore	If only status_code is needed use HEAD instead of GET request to avoid body download	2019-01-03 18:39:43 +01:00
CODE_OF_CONDUCT.md	Add CODE_OF_CONDUCT.md	2019-01-05 00:45:54 +03:30
data.json	added Telegram (search by @nickname)	2019-01-07 13:19:32 +02:00
Dockerfile	Adding docker support	2018-12-31 14:53:27 -06:00
install_packages.sh	Install packages for linux	2019-01-04 11:55:31 +02:00
LICENSE	Update LICENSE	2018-12-24 19:50:49 +01:00
README.md	Added asciinema demo	2019-01-09 01:34:11 +01:00
requirements.txt	Add Colorama to one of the requirements.	2019-01-03 18:17:50 +08:00
sherlock.py	Merge pull request #109 from nareddyt/response-time-metrics	2019-01-08 19:08:47 -05:00
site_list.py	Update script to use with-as structure for files. Add number of supported sites to title. Add status message.	2018-12-30 11:50:10 -06:00
sites.md	bump version	2019-01-09 01:03:11 +03:30

README.md

Sherlock

Find usernames across social networks

[![asciicast](https://asciinema.org/a/IMRMmbAxFGUgd2SJN0rkAfaPb.svg)](https://asciinema.org/a/IMRMmbAxFGUgd2SJN0rkAfaPb)

Installation

NOTE: Python 3.6 or higher is required.

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

# change the working directory to sherlock
$ cd sherlock

# install the requirements
$ pip3 install -r requirements.txt

Usage

$ python3 sherlock.py --help
usage: sherlock.py [-h] [--version] [--verbose] [--quiet] [--tor]
                   [--unique-tor] [--csv] [--site SITE_NAME]
                   USERNAMES [USERNAMES ...]

Sherlock: Find Usernames Across Social Networks (Version 0.2.0)

positional arguments:
  USERNAMES             One or more usernames to check with social networks.

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.
  --quiet, -q           Disable debugging information (Default Option).
  --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.
  --site SITE_NAME      Limit analysis to just the listed sites. Add multiple
                        options to specify more than one site.

For example, run python3 sherlock.py user123, and all of the accounts found will be stored in a text file with the username (e.g user123.txt).

Docker Notes

If you have docker 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 mysherlock-image user123

The --rm flag is optional. It removes the container filesystem after running so you do not have a bunch of leftover container filesystem cruft. See https://docs.docker.com/engine/reference/run/#clean-up---rm

One caveat is the text file that is created will only exist in the container so you will not be able to get at that.

Or you can simply use "Docker Hub" to run sherlock:

docker run theyahya/sherlock user123

License

MIT License