sherlock/README.md

49 lines
1.2 KiB
Markdown
Raw Normal View History

2018-12-24 14:31:03 +00:00
# Sherlock
> Find usernames across over 75 social networks
2018-12-24 14:42:01 +00:00
<p align="center">
2018-12-24 18:50:13 +00:00
<img src="sherlock_preview.png">
2018-12-24 14:42:01 +00:00
</a>
</p>
2018-12-24 18:50:13 +00:00
## Installation
```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]
USERNAMES [USERNAMES ...]
Sherlock: Find Usernames Across Social Networks (Version 0.1.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.
--quiet, -q Disable debugging information (Default Option).
```
2018-12-24 18:53:11 +00:00
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```).
2018-12-24 18:50:13 +00:00
## License
MIT License
Copyright (c) 2018 Siddharth Dushantha