basic_usage.md

Running the Tools

Setup

python3 -m venv venv
source venv/bin/activate        # Linux / macOS
venv\Scripts\activate           # Windows

pip install -r requirements.txt

OSINT Tools

python -m tools/osint/python/email_harvester.py example.com
python -m tools/osint/python/subdomain_finder.py example.com
python -m tools/osint/python/username_lookup.py <username_or_target>

Defensive Tools

python -m tools.defensive.python.firewall_watcher
python -m tools.defensive.python.log_monitor
python -m tools.defensive.python.malware_scanner

Example Demos

python examples/osint_demo.py
python examples/defensive_demo.py
python examples/offensive_demo.py

Bash Scripts (Linux / macOS)

Make scripts executable:

chmod +x tools/automation/bash/*.sh

Run:

./tools/automation/bash/auto_backup.sh
./tools/automation/bash/cleanup.sh
./tools/automation/bash/deploy_script.sh

PowerShell Scripts (Windows)

Run PowerShell as Administrator.

Allow script execution:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Run scripts:

.\tools\automation\powershell\Auto-Deploy.ps1
.\tools\automation\powershell\Backup-Files.ps1
.\tools\automation\powershell\Sync-Drives.ps1

.\tools\defensive\powershell\Check-DefenderStatus.ps1
.\tools\defensive\powershell\Get-EventLogs.ps1
.\tools\defensive\powershell\Monitor-Processes.ps1

Rust Offensive Tool (Fast Port Scanner)

Build

cd tools/offensive/rust/fast_port_scanner
cargo build --release

Run

cargo run --release

Or run binary directly:

./target/release/fast_port_scanner

Running Tests

pytest tests/

Or individually:

pytest tests/test_core.py
pytest tests/test_tools.py
pytest tests/test_utils.py

Makefile

make help
make install
make test
make run

Notes

• Offensive tools must only be used in environments where you have explicit authorization.
• Some scripts may require root / admin privileges
• Defensive tools may need access to system logs or firewall APIs