Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sherlock-project/sherlock

Hunt down social media accounts by username across social networks
https://github.com/sherlock-project/sherlock

cli cti cybersecurity forensics hacktoberfest information-gathering infosec linux osint pentesting python python3 reconnaissance redteam sherlock tools

Last synced: 5 days ago
JSON representation

Hunt down social media accounts by username across social networks

Awesome Lists containing this project

README 

        


  


  

  


  Hunt down social media accounts by username across 400+ social networks

  







  Installation

     •   

  Usage

     •   

  Contributing












## Installation



> [!WARNING]  

> Packages for ParrotOS and Ubuntu 24.04, maintained by a third party, appear to be __broken__.  

> Users of these systems should defer to pipx/pip or Docker.



| Method | Notes |

| - | - |

| `pipx install sherlock-project` | `pip` may be used in place of `pipx` |

| `docker run -it --rm sherlock/sherlock` |

| `dnf install sherlock-project` | |



Community-maintained packages are available for Debian (>= 13), Ubuntu (>= 22.10), Homebrew, Kali, and BlackArch. These packages are not directly supported or maintained by the Sherlock Project.



See all alternative installation methods [here](https://sherlockproject.xyz/installation)



## General usage



To search for only one user:

```bash

sherlock user123

```



To search for more than one user:

```bash

sherlock user1 user2 user3

```



Accounts found will be stored in an individual text file with the corresponding username (e.g ```user123.txt```).



```console

$ sherlock --help

usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]

                [--output OUTPUT] [--tor] [--unique-tor] [--csv] [--xlsx]

                [--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE]

                [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color]

                [--browse] [--local] [--nsfw]

                USERNAMES [USERNAMES ...]



Sherlock: Find Usernames Across Social Networks (Version 0.14.3)



positional arguments:

  USERNAMES             One or more usernames to check with social networks.

                        Check similar usernames using {?} (replace to '_', '-', '.').



optional arguments:

  -h, --help            show this help message and exit

  --version             Display version information and dependencies.

  --verbose, -v, -d, --debug

                        Display extra debugging information and metrics.

  --folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUT

                        If using multiple usernames, the output of the results will be

                        saved to this folder.

  --output OUTPUT, -o OUTPUT

                        If using single username, the output of the result will be saved

                        to this 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.

  --csv                 Create Comma-Separated Values (CSV) File.

  --xlsx                Create the standard file for the modern Microsoft Excel

                        spreadsheet (xlsx).

  --site SITE_NAME      Limit analysis to just the listed sites. Add multiple options to

                        specify more than one site.

  --proxy PROXY_URL, -p PROXY_URL

                        Make requests over a proxy. e.g. socks5://127.0.0.1:1080

  --json JSON_FILE, -j JSON_FILE

                        Load data from a JSON file or an online, valid, JSON file.

  --timeout TIMEOUT     Time (in seconds) to wait for response to requests (Default: 60)

  --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.

  --nsfw                Include checking of NSFW sites from default list.

```

## Apify Actor Usage [![Sherlock Actor](https://apify.com/actor-badge?actor=netmilk/sherlock)](https://apify.com/netmilk/sherlock?fpr=sherlock)



Run Sherlock Actor on Apify



You can run Sherlock in the cloud without installation using the [Sherlock Actor](https://apify.com/netmilk/sherlock?fpr=sherlock) on [Apify](https://apify.com?fpr=sherlock) free of charge.



``` bash

$ echo '{"usernames":["user123"]}' | apify call -so netmilk/sherlock

[{

  "username": "user123",

  "links": [

    "https://www.1337x.to/user/user123/",

    ...

  ]

}]s

```



Read more about the [Sherlock Actor](../.actor/README.md), including how to use it programmaticaly via the Apify [API](https://apify.com/netmilk/sherlock/api?fpr=sherlock), [CLI](https://docs.apify.com/cli/?fpr=sherlock) and [JS/TS and Python SDKs](https://docs.apify.com/sdk?fpr=sherlock).



## Credits



Thank you to everyone who has contributed to Sherlock! ❤️





  




## Star history



  

  

  Sherlock Project Star History Chart



## License



MIT © Sherlock Project


Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)



[ext_pypi]: https://pypi.org/project/sherlock-project/

[ext_brew]: https://formulae.brew.sh/formula/sherlock