Skip to content

Commit c193c2f

Browse files
committed
Document GitHub pip installation
1 parent 3354fb3 commit c193c2f

3 files changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ cd dirsearch
2828
python3 dirsearch.py -u https://example.com -e php,html,js
2929
```
3030

31+
You can also install the latest Python stack directly from GitHub with pip:
32+
33+
```sh
34+
pip3 install git+https://github.com/maurosoria/dirsearch.git
35+
dirsearch -u https://example.com -e php,html,js
36+
```
37+
38+
The Rust native backend is opt-in for source installs; see [Installation](docs/installation.md) for the native build steps.
39+
3140
Pre-built PyInstaller binaries and portable folder archives are available on the [Releases page](https://github.com/maurosoria/dirsearch/releases).
3241

3342
## Documentation

docs/installation.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Supported Platforms
44

5-
dirsearch runs on Python 3.11-3.14 and is distributed as source, Docker image, PyInstaller binary, or portable folder.
5+
dirsearch runs on Python 3.11-3.14 and is distributed as source, installable from GitHub with pip, Docker image, PyInstaller binary, or portable folder.
66

77
| Platform | Architecture | PyInstaller | Portable folder |
88
|----------|--------------|-------------|-----------------|
@@ -25,9 +25,27 @@ python3 dirsearch.py -u https://example.com -w tests/static/wordlist.txt -q
2525
## Other Install Methods
2626

2727
- ZIP archive: [Download the master branch](https://github.com/maurosoria/dirsearch/archive/master.zip).
28+
- GitHub with pip, Python stack: `pip3 install git+https://github.com/maurosoria/dirsearch.git`.
2829
- Docker: `docker pull ghcr.io/maurosoria/dirsearch:v0.5.0-rc1-async`.
2930
- Kali Linux: `sudo apt-get install dirsearch` (deprecated).
3031

32+
## Native Rust from Source
33+
34+
The GitHub pip command installs the Python stack only. To build the Rust native request and wordlist backends from source, install Rust and `maturin`, then build the native wheel from a clone:
35+
36+
```sh
37+
git clone https://github.com/maurosoria/dirsearch.git --depth 1
38+
cd dirsearch
39+
python3 -m pip install .
40+
python3 -m pip install maturin
41+
python3 -m maturin build --release --manifest-path native/Cargo.toml --out dist/native-wheels
42+
python3 -m pip install dist/native-wheels/*.whl
43+
python3 -c "import dirsearch_native"
44+
dirsearch -u https://example.com -w tests/static/wordlist.txt --request-backend native --wordlist-backend native -q
45+
```
46+
47+
Without the native wheel, source installs keep the Python request backend and automatic Python wordlist fallback defaults.
48+
3149
## Release Artifacts
3250

3351
Pre-built release assets are available on the [Releases page](https://github.com/maurosoria/dirsearch/releases).

native/pyproject.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[build-system]
2+
requires = ["maturin>=1.0,<2.0"]
3+
build-backend = "maturin"
4+
5+
[project]
6+
name = "dirsearch-native"
7+
version = "0.1.0"
8+
description = "Rust native backend for dirsearch"
9+
requires-python = ">=3.9"
10+
license = "GPL-2.0-only"
11+
12+
[tool.maturin]
13+
manifest-path = "Cargo.toml"

0 commit comments

Comments
 (0)