dirsearch README

The project's README from github.com/maurosoria/dirsearch. As one markdown file: README.md.

dirsearch logo (light) dirsearch logo (dark)

dirsearch - Web Path Discovery

Build License Stars Release Sponsors Discord Twitter

An advanced web path brute-forcer

dirsearch is being actively developed by @maurosoria and @shelld3v.

Join the Discord server to communicate with the team.

Quick Start

dirsearch requires Python 3.11 or higher.

git clone https://github.com/maurosoria/dirsearch.git --depth 1
cd dirsearch
python3 dirsearch.py -u https://example.com -e php,html,js

You can also install the latest Python stack directly from GitHub with pip:

pip3 install git+https://github.com/maurosoria/dirsearch.git
dirsearch -u https://example.com -e php,html,js

The Rust native backend is opt-in for source installs; see Installation for the native build steps.

Pre-built PyInstaller binaries and portable folder archives are available on the Releases page.

Documentation

The full documentation now lives in docs/:

Minimal Examples

python3 dirsearch.py -u https://target
python3 dirsearch.py -u https://target -e php,html,js
python3 dirsearch.py -u https://target -e php,html,js -w /path/to/wordlist
python3 dirsearch.py -u https://target -r --max-recursion-depth 3

Use python3 dirsearch.py -h for common options or python3 dirsearch.py -hh for the complete CLI help.

Python API

dirsearch can also be used from Python code for local automation, MCP servers, REST wrappers, and agent-controlled scans. The importable API keeps its configuration in FuzzerConfig, so callers do not need to parse CLI flags or mutate CLI globals.

See Python API for examples covering templates, custom wordlists, callbacks, authenticated sessions, and agent-oriented scan recipes.

Contributing

Pull requests and feature requests are welcome. See CONTRIBUTORS.md for the people who have helped improve dirsearch.

License

Copyright (C) Mauro Soria ([email protected])

License: GNU General Public License, version 2.

dirsearch (maurosoria/dirsearch)

red-team
Searching Database…

What is this?Dirsearch is an advanced command-line web path brute-forcer used to discover hidden files and directories on websites for security testing.
Is it a CLI tool or does it have a GUI?It is a Python command-line tool, run as a script, though it can also be imported as a Python API for custom automation.
How do I install and run it?It requires Python 3.11+, can be installed via pip from GitHub, or you can use pre-built PyInstaller binaries, portable archives, or Docker images; once installed, run 'python3 dirsearch.py -h' to see options.
Do I need anything besides Python installed?You need Python 3.11 or higher; there's also an opt-in Rust native backend for source installs if you want extra performance.
Is the Rust backend required or is it optional?No, the Rust native backend is opt-in only for source installs, not required for normal use.
Does it run on Windows and Mac too, not just Linux?Yes, it's cross-platform Python with pre-built binaries, portable folder archives, and Docker images available for multiple platforms.
Can I resume an interrupted scan?Yes, dirsearch supports sessions that let you save, list, and resume scan sessions, as documented in the Sessions guide.
What kinds of wordlists does it support?It supports customizable wordlists with placeholders like %EXT%, plus categories, templates, prefixes, suffixes, and transformations for generating scan targets.
Can I use dirsearch inside my own scripts or AI agents?Yes, it exposes a Python API (via FuzzerConfig) for local automation, MCP servers, REST wrappers, and agent-controlled scans without needing to parse CLI flags.
Where can I find all the CLI options?Run 'python3 dirsearch.py -hh' for the complete command-line help, or check the CLI Options reference in the docs/ folder.
Creator
maurosoria
Size
24.5 MB
Stars
15K
Age
13y
Commits · 90 Days