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)

Searching Database…

Что это такое?Dirsearch — это продвинутый инструмент командной строки для перебора путей веб-сайта, который используется для поиска скрытых файлов и каталогов на сайтах при тестировании безопасности.
Это инструмент командной строки или у него есть графический интерфейс?Это инструмент командной строки на Python, который запускается как скрипт, но его также можно импортировать как Python API для собственной автоматизации.
Как установить и запустить?Нужен Python 3.11+, установить можно через pip из GitHub, либо использовать готовые бинарники PyInstaller, portable-архивы или образы Docker; после установки выполните 'python3 dirsearch.py -h', чтобы увидеть параметры.
Нужно ли что-то кроме установленного Python?Нужен Python 3.11 или выше; также есть необязательный нативный бэкенд на Rust для установки из исходников, если нужна дополнительная производительность.
Бэкенд на Rust обязателен или необязателен?Нет, нативный бэкенд на Rust включается только по желанию и только при установке из исходников; для обычного использования он не нужен.
Работает ли она на Windows и Mac, а не только на Linux?Да, это кроссплатформенный Python-инструмент; готовые бинарники, portable-архивы с папками и образы Docker доступны для нескольких платформ.
Можно ли возобновить прерванное сканирование?Да, dirsearch поддерживает сессии: их можно сохранять, просматривать и возобновлять, это описано в руководстве по сессиям (Sessions).
Какие типы словарей поддерживаются?Поддерживаются настраиваемые словари с плейсхолдерами вроде %EXT%, а также категории, шаблоны, префиксы, суффиксы и трансформации для генерации целей сканирования.
Можно ли использовать dirsearch в собственных скриптах или ИИ-агентах?Да, есть Python API (через FuzzerConfig) для локальной автоматизации, серверов MCP, REST-обёрток и сканирований, которыми управляет агент, без необходимости разбирать флаги командной строки.
Где найти все параметры командной строки?Выполните 'python3 dirsearch.py -hh' для полной справки по командной строке или откройте справочник CLI Options в папке docs/.
Creator
maurosoria
Size
24.7 MB
Stars
15K
Age
13y
Commits · 90 Days