You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
77 lines
2.3 KiB
77 lines
2.3 KiB
# Sherlock
|
|
> Find usernames across [social networks](https://github.com/sdushantha/sherlock/blob/master/sites.md)
|
|
|
|
<p align="center">
|
|
<img src="./screenshot/preview.png">
|
|
</a>
|
|
</p>
|
|
|
|
## Installation
|
|
|
|
**NOTE**: Python 3.6 or higher is required.
|
|
|
|
```bash
|
|
# 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
|
|
|
|
```bash
|
|
$ 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.
|
|
|
|
|
|
Or you can simply use docker to run `sherlock`:
|
|
```
|
|
docker run theyahya/sherlock user123
|
|
```
|
|
|
|
## License
|
|
MIT License
|
|
|
|
Copyright (c) 2018 Siddharth Dushantha
|