Merge pull request #1 from DefensiveOrigins/main

update README

Author: Relkci

README.md

@@ -7,36 +7,57 @@ This repository contains two helper scripts for inspecting Jenkins instances:
 
 Only run these scripts against systems you own or have explicit permission to test.
 
+## Install from PIP:
+
+``` 
+pip install jenkinsenvhunter    
+```
+
+Then:
+
+```
+jenkins-env-hunter --help
+jenkins-check-noauth --help
+```
+
 ## Requirements
 
 - Python 3.7+
 - `requests` (required)
 - `alive-progress` (optional, progress bars)
 
-Install dependencies:
+
+
+
+## Install dependencies (if from git clone)
+
 ```
 pip install requests alive-progress
 ```
 
 ---
 
-## CheckNoAuth.py
+## CheckNoAuth.py & jenkins-check-noauth
 
 Purpose: quickly determine which hosts are running Jenkins and whether anonymous access is allowed. The script can also extract hosts from Nessus `.nessus` exports (plugin 65054).
 
-Usage examples
+Usage examples (Python and PIP versions listed)
 ```
 # Scan hosts listed in hosts.txt using HTTP
 python CheckNoAuth.py -f hosts.txt
+jenkins-check-noauth -f hosts.txt
 
 # Scan hosts using HTTPS and 4 threads
 python CheckNoAuth.py -f hosts.txt --ssl -n 4
+jenkins-check-noauth -f hosts.txt --ssl -n 4
 
 # Extract Jenkins hosts from a Nessus export and scan them
 python CheckNoAuth.py -x scan.nessus
+jenkins-check-noauth -x scan.nessus
 
 # Verbose output for troubleshooting a single host
 python CheckNoAuth.py -f single-host.example.local:8080 -v
+jenkins-check-noauth -f single-host.example.local:8080 -v
 ```
 
 Options summary
@@ -60,23 +81,27 @@ Output
 
 ---
 
-## JenkinsEnvHunter.py
+## JenkinsEnvHunter.py & jenkins-env-hunter
 
 Purpose: enumerate Jenkins jobs and builds and fetch environment variables. Finds likely sensitive variables by default (regex matching `user|pass|key|auth|token|secret`) and can save results to a file.
 
 Usage examples
 ```
 # Scan a Jenkins instance (no auth) and print findings to console
 python JenkinsEnvHunter.py --url http://jenkins.example.local/
+jenkins-env-hunter --url http://jenkins.example.local/
 
 # Scan and save results to a file
 python JenkinsEnvHunter.py --url http://jenkins.example.local/ --output findings.txt
+jenkins-env-hunter --url http://jenkins.example.local/ --output findings.txt
 
 # Scan using credentials (authenticated Jenkins)
 python JenkinsEnvHunter.py --url https://jenkins.example.local/ --user alice --token myapitoken --output findings.txt
+jenkins-env-hunter --url https://jenkins.example.local/ --user alice --token myapitoken --output findings.txt
 
 # Include all environment variables (not only flagged ones)
 python JenkinsEnvHunter.py --url http://jenkins.example.local/ --all
+jenkins-env-hunter --url http://jenkins.example.local/ --all
 ```
 
 Options summary
@@ -108,11 +133,13 @@ Notes
 1. Discover potentially anonymous Jenkins servers:
 ```
 python CheckNoAuth.py -f hosts.txt -n 8
+jenkins-check-noauth -f hosts.txt -n 8
 ```
 
 2. For a discovered server that allows anonymous access, run a targeted environment scan:
 ```
 python JenkinsEnvHunter.py --url http://jenkins.example.local/ --output scan_report.txt
+jenkins-env-hunter --url http://jenkins.example.local/ --output scan_report.txt
 ```
 
 ---