Enter the Grid →
// quick-start

Python &
CLI Guide.

Many of the best OSINT tools run from the command line. This guide gets you from zero to running your first tool — no prior experience needed.

What is Python?

Python is a programming language that many OSINT tools are written in. You don't need to learn to code — you just need Python installed so your computer can run those tools.

Think of it like a engine. The tool is the car. You don't need to build the engine — you just need it installed.

Always download Python from the official source: python.org/downloads. Download the latest stable version (3.x).

CMD vs PowerShell

Windows has two command line interfaces. For OSINT tools, either works — but they have small differences worth knowing.

how to open cmd
Press Win + R → type cmd → press Enter
or search "Command Prompt" in the Start menu

CMD is the older, simpler interface. Most OSINT tool instructions are written for CMD. If a guide says "open a terminal", CMD works fine.

useful commands
cd C:\Users\You\Desktop\sherlock   # navigate to folder
cd ..                              # go up one folder
dir                                # list files in current folder
cls                                # clear the screen
python sherlock.py username        # run a script
how to open powershell
Press Win + X → select "Windows PowerShell"
or search "PowerShell" in the Start menu

PowerShell is more powerful and modern. Some tools work better here. The main difference you'll notice: use ./ instead of just the script name.

useful commands
cd C:\Users\You\Desktop\sherlock   # navigate to folder
cd ..                              # go up one folder
ls                                 # list files (not dir)
cls                                # clear the screen
python ./sherlock.py username      # run a script

Getting a tool from GitHub

Most OSINT tools live on GitHub — a platform where developers share code. You don't need a GitHub account to download tools.

There are two ways to get a tool. The easiest is downloading a ZIP. The better way is using Git, which makes updating the tool later much easier.

  • 01
    Go to the tool's GitHub page (e.g. github.com/sherlock-project/sherlock).
  • 02
    Click the green Code button → click Download ZIP.
  • 03
    Extract the ZIP to a folder you'll remember — e.g. C:\OSINT\sherlock.
  • 04
    Open CMD, navigate to that folder with cd C:\OSINT\sherlock, then follow the tool's install instructions.
  • 01
    Install Git from git-scm.com. Use default settings during install.
  • 02
    Open CMD in the folder where you want to save the tool.
  • 03
    Run git clone https://github.com/sherlock-project/sherlock (replace URL with the tool you want).
  • 04
    To update later: cd sherlock then git pull. Done — always the latest version.

Installing dependencies with pip

Most tools need extra Python packages to work. These are listed in a file called requirements.txt. You install them with pip — Python's package manager.

standard install — run this inside the tool's folder
pip install -r requirements.txt

Some tools have their own install command listed in their README. Always check the README first — it's the page you see when you open a GitHub repo.

install a single package
pip install requests
pip install beautifulsoup4
pip install sherlock-project  # some tools can be installed directly

If pip isn't recognized, try pip3 instead. On some systems Python 3 uses pip3.

Virtual environments

Some tools conflict with each other's dependencies. A virtual environment is an isolated space for each tool — like a separate room so they don't interfere. Optional, but good practice.

create and activate a virtual environment
python -m venv venv          # create it (run once)
venv\Scripts\activate        # activate it (CMD)
venv\Scripts\Activate.ps1   # activate it (PowerShell)
pip install -r requirements.txt  # now install inside it
deactivate                   # exit the environment

You'll know it's active when you see (venv) at the start of your command line. Always activate before running the tool.

Running a tool

Once installed, most tools follow the same pattern — Python, then the script name, then your input.

general pattern
python toolname.py [your input]
real examples
python sherlock.py johndoe               # search username
python holehe.py [email protected]        # check email
python maigret.py johndoe --all-sites    # detailed username search
python theHarvester.py -d domain.com -b google  # domain harvest

Most tools also have a help flag that lists all available options:

python sherlock.py --help

Common errors & fixes

error 01
'python' is not recognized as an internal or external command
Python isn't in your PATH. Reinstall Python and make sure to check Add Python to PATH on the first screen. Alternatively, try python3 instead of python.
error 02
ModuleNotFoundError: No module named 'requests'
A required package isn't installed. Run pip install requests (replace with whatever module name it says). Or run pip install -r requirements.txt again.
error 03
pip is not recognized
Try pip3 instead of pip. If that also fails, run python -m pip install [package].
error 04
running scripts is disabled on this system (PowerShell)
PowerShell is blocking script execution. Run this once as Administrator: Set-ExecutionPolicy RemoteSigned. Then try activating the virtual environment again.
error 05
No such file or directory
You're not in the right folder. Use cd to navigate to where the tool is. Type dir (CMD) or ls (PowerShell) to see what's in the current folder.
error 06
SyntaxError or IndentationError
Usually means you're running a Python 2 tool with Python 3 (or vice versa). Try python2 toolname.py or check the tool's README for version requirements.

Quick reference

cheat sheet — most common commands
python --version                    # check Python version
pip --version                       # check pip version
pip install -r requirements.txt     # install tool dependencies
pip install packagename             # install a single package
pip list                            # see installed packages
pip update packagename              # update a package
python toolname.py --help           # see tool options
cd foldername                       # enter a folder
cd ..                               # go up one folder
dir                                 # list files (CMD)
ls                                  # list files (PowerShell)
cls                                 # clear screen
git clone [url]                     # download a GitHub repo
git pull                            # update a cloned repo

Still stuck? Use the contact form and describe the error you're seeing — include the full error message and which tool you're trying to run.