Skip to content

Commit e8ae7d0

Browse files
authored
Update INSTALL.md
1 parent 753e7c4 commit e8ae7d0

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

Docs/INSTALL.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img width="1536" height="1024" alt="dorkeye-install" src="https://github.com/user-attachments/assets/a0983dc1-2c2e-4cbd-9ab9-7ae1a3743f29" />
1+
![dorkeye-install](https://private-user-images.githubusercontent.com/153435050/539346754-a0983dc1-2c2e-4cbd-9ab9-7ae1a3743f29.png)
22

33
# 📦 DorkEye — Installation Guide
44

@@ -8,19 +8,19 @@ Official installation guide for **DorkEye Project**.
88

99
## ⚡ Quickest Install (PyPI)
1010

11-
```bash
11+
```
1212
pip install dorkeye
1313
```
1414

15-
No virtual environment needed. Works on Linux, macOS, and Windows.
15+
Works on Linux, macOS, and Windows. Recommended for quick testing — for production use, a virtual environment is preferred.
1616

1717
-----
1818

1919
## 🔗 Download
2020

2121
Clone the repository:
2222

23-
```bash
23+
```
2424
git clone https://github.com/xPloits3c/DorkEye.git
2525
```
2626

@@ -79,7 +79,7 @@ Or download the latest release:
7979

8080
This method works on **Linux**, **macOS**, and **Windows**.
8181

82-
```bash
82+
```
8383
# Clone the repository
8484
git clone https://github.com/xPloits3c/DorkEye.git
8585
cd DorkEye
@@ -110,7 +110,7 @@ python dorkeye.py -h
110110

111111
DorkEye auto-detects Termux and activates battery-saver mode (reduced timeouts, fewer probe samples). No additional flags needed.
112112

113-
```bash
113+
```
114114
# Install Python and git
115115
pkg update && pkg upgrade
116116
pkg install python git
@@ -143,13 +143,13 @@ python dorkeye.py --wizard
143143

144144
Install DorkEye as a system command for direct access from anywhere:
145145

146-
```bash
146+
```
147147
pip install -e .
148148
```
149149

150150
Then use:
151151

152-
```bash
152+
```
153153
dorkeye --help
154154
dorkeye --wizard
155155
dorkeye -d "inurl:admin" -o results.html
@@ -163,7 +163,7 @@ This mode is recommended for advanced users who want `dorkeye` available globall
163163

164164
Run these commands to verify everything works:
165165

166-
```bash
166+
```
167167
# Show help and all available flags
168168
python dorkeye.py -h
169169
@@ -182,7 +182,7 @@ python dorkeye.py --wizard
182182

183183
If using CLI mode:
184184

185-
```bash
185+
```
186186
dorkeye --dg=all -c 5 -o test.html
187187
```
188188

@@ -200,7 +200,7 @@ DorkEye/
200200
├── Tools/
201201
│ ├── dork_generator.py # Dork Generator engine (--dg)
202202
│ ├── dorkeye_agents.py # Analysis + Crawl agents (--analyze, --crawl)
203-
│ ├── dorkeye_analyze.py # Standalone analysis script
203+
│ ├── dorkeye_analyze.py # Standalone analysis script (executable directly)
204204
│ └── dorkeye_patterns.py # Pattern matching utilities
205205
├── Templates/
206206
│ ├── dorks_templates.yaml # Default dork templates
@@ -219,7 +219,7 @@ DorkEye/
219219

220220
The search engine module has been renamed. Fix:
221221

222-
```bash
222+
```
223223
pip uninstall duckduckgo-search -y
224224
pip install ddgs
225225
```
@@ -228,7 +228,7 @@ pip install ddgs
228228

229229
Modern Debian-based systems block global pip installs. Always use a virtual environment:
230230

231-
```bash
231+
```
232232
python3 -m venv dorkeye_env
233233
source dorkeye_env/bin/activate
234234
pip install -r requirements.txt
@@ -242,7 +242,7 @@ pip install -r requirements.txt
242242

243243
The `--templates` flag requires `=` syntax (no space):
244244

245-
```bash
245+
```
246246
# ✅ Correct
247247
python dorkeye.py --dg=sqli --templates=dorks_templates.yaml
248248
@@ -254,8 +254,8 @@ python dorkeye.py --dg=sqli --templates dorks_templates.yaml
254254

255255
The `--analyze` and `--crawl` features require `dorkeye_agents.py` in the `Tools/` directory. If missing, DorkEye runs normally but these features are disabled. Ensure your clone is up to date:
256256

257-
```bash
258-
git pull origin main
257+
```
258+
git pull origin master
259259
```
260260

261261
### HTTP Fingerprinting disabled warning
@@ -270,16 +270,16 @@ DorkEye disables SSL verification for maximum compatibility during OSINT scannin
270270

271271
## 🔄 Updating DorkEye
272272

273-
```bash
273+
```
274274
cd DorkEye
275-
git pull origin main
275+
git pull origin master
276276
pip install --upgrade -r requirements.txt
277277
```
278278

279279
If installed in CLI mode:
280280

281-
```bash
282-
pip install -e . --upgrade
281+
```
282+
pip install -e .
283283
```
284284

285285
-----
@@ -288,25 +288,25 @@ pip install -e . --upgrade
288288

289289
**Linux / macOS:**
290290

291-
```bash
291+
```
292292
rm -rf DorkEye
293293
```
294294

295295
**Windows:**
296296

297-
```bash
297+
```
298298
rmdir /s /q DorkEye
299299
```
300300

301301
**Remove only the virtual environment:**
302302

303-
```bash
303+
```
304304
rm -rf dorkeye_env
305305
```
306306

307307
**If installed in CLI mode:**
308308

309-
```bash
309+
```
310310
pip uninstall dorkeye
311311
```
312312

@@ -342,4 +342,4 @@ Please include:
342342

343343
## 🎯 Installation Complete
344344

345-
DorkEye v4.8 is ready. Happy hunting. 🔍
345+
DorkEye is ready! Happy hunting. 🔍

0 commit comments

Comments
 (0)