mirror of https://github.com/sherlock-project/sherlock synced 2024-11-15 08:47:08 +00:00

No description

Find a file

Yahya SayadArbabi 5f4df01e97 Fix the lenght		2019-01-05 01:19:15 +03:30
.dockerignore	Adding docker support	2018-12-31 14:53:27 -06:00
.gitignore	Merge remote-tracking branch 'upstream/master' into async-requests	2018-12-30 00:10:31 -05:00
data.json	Fix the lenght	2019-01-05 01:19:15 +03:30
Dockerfile	Adding docker support	2018-12-31 14:53:27 -06:00
LICENSE	Update LICENSE	2018-12-24 19:50:49 +01:00
preview.png	Added the image back.	2018-12-30 09:46:59 +01:00
README.md	Adding docker support	2018-12-31 14:53:27 -06:00
requirements.txt	Merge remote-tracking branch 'upstream/master' into async-requests	2018-12-30 00:10:31 -05:00
sherlock.py	Adding a counter of resources	2019-01-02 16:43:38 +01: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	Add 9gag	2019-01-03 03:57:28 +03:30

README.md

Sherlock

Find usernames across social networks

Installation

NOTE: Python 3.6 or higher is required.

# clone the repo
$ git clone https://github.com/sdushantha/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] [--csv] [--tor] [--unique-tor]
                   USERNAMES [USERNAMES ...]

Sherlock: Find Usernames Across Social Networks (Version 2018.12.30)

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.
  --quiet, -q           Disable debugging information (Default Option).
  --csv                 Create Comma-Separated Values (CSV) 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.

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.

License

MIT License