Package: sherlock-pip
Hunt down social media accounts by username acrosssocial networksInstallation|Usage|Docker Notes|ContributingInstallation#clonetherepo$gitclonehttps://github.com/sherlock-project/sherlock.git#changetheworkingdirectorytosherlock$cdsherlock#installtherequirements$python3-mpipinstall-rrequirements.txtUsage$python3sherlock--helpusage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT][--output OUTPUT] [--tor] [--unique-tor] [--csv][--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE][--timeout TIMEOUT] [--print-all] [--print-found] [--no-color][--browse] [--local]USERNAMES [USERNAMES ...]Sherlock: Find Usernames Across Social Networks (Version 0.14.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, --debugDisplay extra debugging information and metrics.--folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUTIf using multiple usernames, the output of the resultswill be saved to this folder.--output OUTPUT, -o OUTPUTIf using single username, the output of the resultwill be saved to this file.--tor, -t             Make requests over Tor; increases runtime; requiresTor to be installed and in system path.--unique-tor, -u      Make requests over Tor with new Tor circuit after eachrequest; increases runtime; requires Tor to beinstalled and in system path.--csv                 Create Comma-Separated Values (CSV) File.--site SITE_NAME      Limit analysis to just the listed sites. Add multipleoptions to specify more than one site.--proxy PROXY_URL, -p PROXY_URLMake requests over a proxy. e.g.socks5://127.0.0.1:1080--json JSON_FILE, -j JSON_FILELoad data from a JSON file or an online, valid, JSONfile.--timeout TIMEOUT     Time (in seconds) to wait for response to requests.Default timeout is infinity. A longer timeout will bemore likely to get results from slow sites. On theother hand, this may cause a long delay to gather allresults.--print-all           Output sites where the username was not found.--print-found         Output sites where the username was found.--no-color            Don't color terminal output--browse, -b          Browse to all results on default browser.--local, -l           Force the use of the local data.json file.To search for only one user:python3 sherlock user123To search for more than one user:python3 sherlock user1 user2 user3Accounts found will be stored in an individual text file with the corresponding username (e.guser123.txt).Anaconda (Windows) NotesIf you are using Anaconda in Windows, using 'python3' might not work. Use 'python' instead.Docker NotesIf docker is 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 -t mysherlock-image user123The optional--rmflag removes the container filesystem on completion to prevent cruft build-up. See:https://docs.docker.com/engine/reference/run/#clean-up---rmThe optional-tflag allocates a pseudo-TTY which allows colored output. See:https://docs.docker.com/engine/reference/run/#foregroundUse the following command to access the saved results:docker run --rm -t -v "$PWD/results:/opt/sherlock/results" mysherlock-image -o /opt/sherlock/results/text.txt user123The-v "$PWD/results:/opt/sherlock/results"options tell docker to create (or use) the folderresultsin the
present working directory and to mount it at/opt/sherlock/resultson the docker container.
The-o /opt/sherlock/results/text.txtoption tellssherlockto output the result.Or you can use "Docker Hub" to runsherlock:docker run theyahya/sherlock user123Usingdocker-composeYou can use thedocker-compose.ymlfile from the repository and use this command:docker-compose run sherlock -o /opt/sherlock/results/text.txt user123ContributingWe would love to have you help us with the development of Sherlock. Each and every contribution is greatly valued!Here are some things we would appreciate your help on:Addition of new site support Â¹Bringing back site support ofsites that have been removedin the past due to false positives[1] Please look at the Wiki entry onadding new sitesto understand the issues.TestsThank you for contributing to Sherlock!Before creating a pull request with new development, please run the tests
to ensure that everything is working great.  It would also be a good idea to run the tests
before starting development to distinguish problems between your
environment and the Sherlock software.The following is an example of the command line to run all the tests for
Sherlock.  This invocation hides the progress text that Sherlock normally
outputs, and instead shows the verbose output of the tests.$ cd sherlock/sherlock
$ python3 -m unittest tests.all --verboseNote that we do currently have 100% test coverage.  Unfortunately, some of
the sites that Sherlock checks are not always reliable, so it is common
to get response problems.  Any problems in connection will show up as
warnings in the tests instead of true errors.If some sites are failing due to connection problems (site is down, in maintenance, etc)
you can exclude them from tests by creating atests/.excluded_sitesfile with a
list of sites to ignore (one site name per line).Stargazers over timeLicenseMIT Â© Sherlock ProjectOriginal Creator -Siddharth Dushantha