Skip to main content

A modular cybersecurity CLI tool for scanning, recon, and malware analysis.

Project description

Inspector

Inspector is a beginner-friendly cybersecurity toolkit designed to make common security assessment tasks simple, educational, and accessible. Its modular design helps newcomers understand the basics of cybersecurity, networking, and reconnaissance before moving on to more advanced tools. Inspector emphasizes clarity, ease of use, and practical learning, making it an ideal starting point for anyone new to the field.


Version

Current version: 1.1.0


Features

  • 🔍 Multi-threaded port scanning for speed (since 0.1.0 BETA)
  • 🌐 Fast subdomain enumeration (since 0.2.0 ALPHA)
  • 🏷️ Banner grabbing for open ports (now grabs banners from all frequently used ports) (basic since 0.2.1 BETA, upgraded in 0.2.3 BETA)
  • 📂 Path enumerator (directory brute-forcer) (since 0.2.2)
  • 🧠 Validates hostnames and IP addresses (since 0.1.1 BETA)
  • ⚙️ Configurable settings stored in settings.json (autocreated at first run) (replaced config.txt in 1.1.0)
  • 🛠️ Modular design for future tools (since 0.2.0 ALPHA)
  • 📝 Displays open ports with descriptions and common vulnerabilities (since 0.1.1 BETA)
  • 🦠 Malware Analyser (uses VirusTotal for scanning hashes, URLs, and files) (hash identifier since 0.3.1 BETA, renamed and upgraded in 0.3.2 BETA)
  • 🗂️ Domain DNS/WHOIS Lookup (added in 0.4.0, improved with DNS resolver in 0.4.1 BETA)
  • 🌍 IP WHOIS Lookup (added in 0.4.2 BETA)
  • 🔄 Reverse DNS Lookup (added in 0.4.2 BETA)
  • 🧩 Unified Recon & OSINT menu (since 0.4.3 BETA)
  • 🎨 Consistent color-coded exception and info messages (since 0.4.3 BETA)
  • 📝 Scan Logging (since 0.5.0 BETA — enabled by default, toggle via settings.json)
  • 🔗 Tool Chaining for Full Recon Scan (added in 0.5.1 BETA — run Port Scanner + OSINT tools in one go)
  • ⚙️ Interactive Settings Editor (new in 1.1.0 — edit settings.json directly from CLI)
  • 📖 Built-in Guide (new in 1.1.0 — learn how to use Inspector directly from the menu)

Current Toolset

🔹 Port Scanner

  • Fast and customizable scanning with thread and timeout control
  • Takes an IP or domain as input
  • Prints out open ports, a brief description for each, and common vulnerabilities associated with those ports
  • Includes banner grabbing for all frequently used ports

🔹 Recon & OSINT

  • Subdomain Enumerator: Quickly finds subdomains for a given domain
  • Path Enumerator (Directory Brute-Forcer): Enumerates directories/paths on web servers to find hidden or sensitive locations
  • DNS/WHOIS Lookup: Retrieves DNS and WHOIS information for domains (with DNS resolver integration)
  • IP WHOIS Lookup: Retrieves WHOIS information for resolved IP addresses
  • Reverse DNS Lookup: Resolves hostnames for IP addresses found

🔹 Malware Analyser

  • Uses the VirusTotal API to scan hash values, URLs, and files for malware analysis

🔹 Settings & Guide

  • Interactive settings editor to configure Inspector without leaving the CLI
  • Built-in guide that explains how each tool works and how to use it effectively

How to Use

  1. Install the package using pip:

    pip install inspector-cli
    
  2. First run will create settings.json automatically at:

    • Unix/Linux: ~/.config/inspector-cli/settings.json
    • Windows: %AppData%\Inspector-CLI\settings.json

    Example settings.json:

    {
      "logging_enabled": true,
      "timeout": 0.7,
      "max_threads": 100,
      "start_port": 1,
      "end_port": 1023,
      "vt_api_key": "Your_API_Key"
    }
    
  3. Run the toolkit:

    inspector
    
    • Select the tool you want to use (Port Scanner, Recon & OSINT, Full Recon Scan, Malware Analyser, or Settings/Guide).
    • Follow the prompts for each tool.
    • For the Malware Analyser, register a VirusTotal account and place your API key in settings.json or via the CLI editor.
    • For Full Recon Scan, enter a domain and Inspector will automatically chain scanning and recon tools.

    Note:

    • All exception and status messages now use consistent prefixes and color coding.
    • Scan logs are enabled by default (can be disabled in settings.json).
    • Settings editor and guide are new in 1.1.0.

Folder Structure

The project folder structure was reorganized in 0.2.0 ALPHA for better modularity.
Each core tool now resides in its own directory, making it easier to expand and maintain the toolkit.


Planned

  • Plugin support (custom tools via plugins/ folder)
  • General UX improvements
  • CLI flags for silent/full recon modes
  • New tools and upgrades to existing ones

License

This project is licensed under the GNU General Public License v3.0.

  • You’re free to use, study, share, and modify the code.
  • You must also share your changes under the same license.
  • No one can legally steal or privatize your code.
  • Commercial use is allowed only if they also keep it open-source and credit the original developer.

📖 Read more: GNU GPL v3.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inspector_cli-1.1.1.tar.gz (10.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

inspector_cli-1.1.1-py3-none-any.whl (9.9 MB view details)

Uploaded Python 3

File details

Details for the file inspector_cli-1.1.1.tar.gz.

File metadata

  • Download URL: inspector_cli-1.1.1.tar.gz
  • Upload date:
  • Size: 10.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for inspector_cli-1.1.1.tar.gz
Algorithm Hash digest
SHA256 77946e81d240f83be355e6744e8f6250a4cf5f16eb964bb20e887baceda4633d
MD5 b218e2d60f030ff14122987f0040269c
BLAKE2b-256 a35427e0eb05279e33d8bff0df9aeb386d1ab6fdf0194bcab083c0dafddb957b

See more details on using hashes here.

File details

Details for the file inspector_cli-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: inspector_cli-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for inspector_cli-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 df78b54806718863ce6ade298ddac9d81d224b514cfc4b5066146e931823856e
MD5 41104caac7f62c66a226b9fda6ccc08f
BLAKE2b-256 0e868a0aa48eb6743b2acc89baee434219df8794858d1395edb00d19265fff5d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page