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 可执行文件、便携压缩包或 Docker 镜像;安装完成后,运行 'python3 dirsearch.py -h' 即可查看选项。
除了安装 Python,还需要别的东西吗?需要 Python 3.11 或更高版本。如果想获得更高性能,可以在源码安装时选择启用可选的 Rust 原生后端。
Rust 后端是必需的还是可选的?可选。Rust 原生后端只能在源码安装时手动启用,正常使用并不需要。
它除了能在 Linux 上运行,也能在 Windows 和 Mac 上运行吗?可以。它是跨平台的 Python 程序,并提供多种平台的预构建可执行文件、便携文件夹压缩包和 Docker 镜像。
我能中断后继续扫描吗?可以。dirsearch 支持会话功能,可以保存、列出并恢复扫描会话,详见 Sessions 指南。
它支持哪些类型的字典?支持可自定义的字典,可使用 %EXT% 等占位符,还支持分类、模板、前缀、后缀和转换规则,用于生成扫描目标。
我能在自己的脚本或 AI 智能体中使用 dirsearch 吗?可以。它提供 Python API(通过 FuzzerConfig),可用于本地自动化、MCP 服务器、REST 封装,以及由智能体控制的扫描,无需解析命令行参数。
在哪里可以找到所有命令行选项?运行 'python3 dirsearch.py -hh' 可查看完整的命令行帮助,也可以查看 docs/ 文件夹中的 CLI Options 参考文档。
Creator
maurosoria
Size
24.7 MB
Stars
15K
Age
13y
Commits · 90 Days