Mirrors/sherlock
2
0
Fork 0
mirror of https://github.com/sherlock-project/sherlock synced 2024-11-15 16:47:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
sherlock/README.md
Chris Blumentritt b96da0b547 Adding docker support
2018-12-31 14:53:27 -06:00

2.2 KiB
Raw Blame History

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

Copyright (c) 2018 Siddharth Dushantha