Guide · Open source
How to use Sherlock: find usernames across social sites
Updated · written with AI from the project's own documentation and checked against our catalogue data
Sherlock is a free, open-source command-line program written in Python. It checks a list of social media sites and websites to see whether a given username is registered on each one, so you can find public profiles quickly. This guide explains what it is, what you need before installing it, how to get the code from GitHub, and how to use its results with care.
Sherlocksherlock-project/sherlock · ★ 95.4k · MIT Install options & downloads Quick start
- 1Check for Python 3. Confirm that Python 3 is installed and available in your terminal before continuing.
- 2Open a terminal in your target folder. Choose the folder where you want the project to live and open a terminal there.
- 3Clone the repository. Run git clone https://github.com/sherlock-project/sherlock.git to download the source code.
- 4Follow the README build steps. Open the cloned folder and follow the README instructions to build and set up Sherlock, since those steps are not covered in this guide.
- 5Confirm you have authorization. Make sure your search is for an approved engagement, your own usernames, or another legitimate purpose before running it.
- 6Verify every match. Open each reported profile and check it manually before treating it as the same person.
What Sherlock does and who it is for
Sherlock searches a list of social media and websites for a particular username and reports which sites have a matching account. The project describes itself as an OSINT (open-source intelligence) tool and is widely used in security and investigation circles.
It is best suited to security researchers doing authorized open-source intelligence work, penetration testers checking username exposure during an approved engagement, developers comfortable with Python command-line tools, and people checking whether their own usernames are used across sites.
What you need before you install Sherlock
Sherlock is run from a terminal. The only prerequisite listed for the project is Python 3, so check that Python 3 is available on your machine before you start. The source does not describe a graphical interface, so plan to work at the command line.
- Python 3 installed on your computer
- Comfort opening a terminal and running commands
- Permission to search for the username you are checking
Install Sherlock by cloning the repository
The project is installed by cloning its repository from GitHub and building it locally. Run the clone command below in a terminal to download a copy of the source code into a folder on your machine.
The source material for this guide covers only the clone step. For the build and run steps, follow the instructions in the project README in the cloned folder, since those details are not reproduced here.
git clone https://github.com/sherlock-project/sherlock.gitRun a username search and read the results
Once Sherlock is set up, it searches its list of sites for the username you provide and reports the sites where a matching account appears. Each result is a candidate match, not proof that the same person owns every account.
Review each hit by opening the profile yourself and checking whether it really belongs to the username holder you are researching. Keep notes on which matches you confirmed and which you rejected.
- Treat every result as a lead to verify
- Check profile details such as photos, bio and activity before drawing conclusions
- Record the date and source of your search for your own records
Use Sherlock responsibly and within the law
Sherlock exists to surface accounts tied to a username, so it can be used to track or profile people. Only use it for authorized work, such as an approved security engagement, or to check your own usernames. Do not use it to track or profile someone without their consent.
Username matches can belong to different people who happen to share a name. Do not rely on Sherlock for guaranteed accurate results.
Compare Sherlock with similar tools
Sherlock is not the only option in this space. Comparable projects include Maigret, WhatsMyName and Social Analyzer. Try a few on the same authorized test case to see which list of sites, output and workflow suits your work best.
- Maigret
- WhatsMyName
- Social Analyzer
What people use it for
- A penetration tester checking how exposed a client's usernames are across public sites during an approved engagement.
- A security researcher mapping which platforms a known handle is registered on as part of authorized OSINT work.
- A developer checking whether their own usernames are already taken on a range of sites.
- A student learning how OSINT tools gather public account information from a command line.
Frequently asked questions
Is Sherlock free to use?
Sherlock is released under the MIT licence and its source code is on GitHub. The MIT licence permits use of the code under its terms, and the source material does not mention any fees.
What do I need to install Sherlock?
The listed prerequisite is Python 3. You install Sherlock by cloning the repository from GitHub with git clone and then following the README build steps.
Does Sherlock have a graphical interface?
No graphical interface is described in the source. Sherlock runs from a terminal, so it is better suited to people comfortable with command-line tools.
Is Sherlock accurate?
Results are matches for a username, not confirmed identities. Different people can share the same username, so verify each profile yourself before relying on it.
Is it legal to use Sherlock?
Use it only for authorized purposes, such as an approved security engagement or checking your own usernames. Using it to track or profile someone without consent is not an appropriate use.
What are good alternatives to Sherlock?
Comparable projects named in the source include Maigret, WhatsMyName and Social Analyzer. Testing a few on the same authorized case will show which fits your workflow.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Sherlock suits security researchers, penetration testers and developers who are comfortable with Python and the command line and who have authorization for their searches. It is a poor fit for non-technical users, for anyone who needs guaranteed accurate identities, or for anyone wanting to track a person without consent.
Install options & downloads