user-scanner README

The project's README from github.com/kaifcodec/user-scanner. As one markdown file: README.md.

User Scanner

User Scanner Logo

Discord

kaifcodec%2Fuser-scanner | Trendshift

A powerful 2-in-1 OSINT suite engineered for deep Email and Username Intelligence.

With 550+ total scan vectors—including 175+ email-integrated sites and 375+ username platforms—you can map digital footprints, analyze target behavior, uncover interests, full metadata of usernames and verify account registrations in seconds.

💖 Sponsored by

WebVetted Sponsor Banner
Go beyond account enumeration. WebVetted turns an email or username into a complete identity investigation with deep OSINT enrichment, breach intel, AI analysis, and an interactive identity graph.
Start an Investigation →

banner-github
Comprehensive OSINT platform for professional investigators and analysts. Reverse email, phone number, and username search across 250+ modules. Automate your intelligence gathering with our powerful tools.
Get Started →

banner-github
Find beginner-friendly open-source issues and make your first pull request today.
Get Started →

✨ Key Features

🚀 Installation

# Upgrade pip and install user-scanner
python3 -m pip install --upgrade pip
pip install user-scanner

# Optional: Install with MCP Server support for AI agents
pip install "user-scanner[mcp]"

📦 Virtual Environment Setup

# Create and activate virtual environment
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\Activate.ps1

# Install package
pip install user-scanner

❄️ Via Nix (Linux & macOS)

# Run instantly without installing permanently
nix run github:kaifcodec/user-scanner/main -- --help

# Drop into a temporary shell with user-scanner active
nix shell github:kaifcodec/user-scanner/main

💻 Usage Guide

1. Basic Username & Email Scanning

Scan a single username or email address across all available platform modules:

user-scanner -u johndoe             # Single username scan
user-scanner -e [email protected]   # Single email scan

2. Cross-Scan & Pivot Intelligence

An email scan proves an account exists but rarely reveals a handle. --cross-scan mines exposed handles, profile links, and secondary email addresses from target profiles, pivoting into multi-pass reconnaissance across all matching platforms:

Pivot Direction What it Mines
-e → username Handles or social links exposed on an email's registered profile
-u → username Secondary aliases advertised across target social profiles
-u → email Public email addresses published on target profile pages
-e → email Secondary addresses exposed by initial email profiles 
user-scanner -u johndoe --cross-scan                                  # Pivot from username scan
user-scanner -e [email protected] --cross-scan                        # Pivot from email scan
user-scanner -e [email protected] --cross-scan --cross-links verified # Platform-verified links only
user-scanner -u johndoe --cross-scan --cross-depth 2        # Follow links two hops deep

💡 *For confidence scoring, link classification rules, and cost models, see docs/CROSS_SCAN.md.*

3. Hudson Rock Malware Breach Intelligence

Check if a target username or email address has been exposed in infostealer malware infection logs:

user-scanner -u johndoe --hudson             # Username malware log check
user-scanner -e [email protected] --hudson   # Email malware log check

🖼️ *To view output terminal screenshots and visual previews, see docs/EXAMPLES.md.*

4. Targeted Category & Module Scanning

Scan specific categories or individual modules, or list available modules in a responsive grid:

user-scanner -u johndoe -c dev                # Developer platforms only
user-scanner -e [email protected] -m github   # Single module check
user-scanner -u johndoe -m github,instagram   # Specific comma-separated modules

user-scanner -lu                              # List user categories & modules grid
user-scanner -le                              # List email categories & modules grid

5. Bulk File Scanning

Scan multiple targets from an input file (one target per line):

user-scanner -uf usernames.txt   # Bulk username scan
user-scanner -ef emails.txt      # Bulk email scan

6. Report Exports, Options & Proxies

# Export results to PDF, JSON, or CSV
user-scanner -u johndoe -f pdf -o report.pdf
user-scanner -u johndoe -f json -o results.json

# Verbose URL reporting and show all results (including not found)
user-scanner -u johndoe -v --all

# Rotate proxies with pre-scan validation check
user-scanner -u johndoe -P proxies.txt --validate-proxies

7. AI & LLM Agent Integration (MCP Server)

Connect user-scanner directly to AI coding assistants and LLM platforms via the Model Context Protocol (MCP). This enables AI agents (Claude Desktop, Cursor, Antigravity, Open-WebUI) to autonomously investigate handles and emails, pivot on exposed profiles, and analyze digital footprints.

Starting the Server

# Start the MCP server over standard I/O (stdio)
user-scanner-mcp

# Optional: Enable verbose logging to stderr
user-scanner-mcp -v

MCP Client Configuration

Add user-scanner to your client configuration (e.g. claude_desktop_config.json or mcp_config.json):

{
  "mcpServers": {
    "user-scanner": {
      "command": "user-scanner-mcp"
    }
  }
}

Exposed AI Tools

Tool Description Capabilities
scan_username Deep username OSINT & profile enrichment across platforms Targeted scans (category, module), recursive cross_scan, proxy injection, loudness toggles
scan_email Deep email verification & account discovery across platforms Target scoping, automated link pivoting (cross_scan), custom proxies, loudness toggles
list_available_modules Dynamic catalog & module discovery Allows AI agents to query all supported platforms and categories dynamically

📚 Documentation Hub

Explore detailed documentation guides in the docs/ directory:

🐍 Python Library Mode

Integrate the User Scanner engine directly into your Python scripts:

import asyncio
from user_scanner.core import engine
from user_scanner.email_scan.shopping import etsy

async def main():
    # Engine validates target against module and returns Result object
    result = await engine.check(etsy, "[email protected]")
    print(result.to_json())

asyncio.run(main())

💡 *For complete Python API documentation and batch category checking examples, see docs/USAGE.md.*

💖 Support the Project

Web platforms constantly update authentication flows. Maintaining over 550+ scan modules requires around-the-clock commitment to keep the suite reliable and free for the cybersecurity community.

If user-scanner has saved you hours of manual pivoting or aided your investigations, consider supporting the project:

👉 Sponsor on GitHub

Project Sponsors

Huge thanks to our amazing sponsors who support the ongoing development of user-scanner!

soxoj
@soxoj 		hienyimba
@hienyimba 		InDieTasten
@InDieTasten

📜 Contributing

We welcome community contributions! Please read our Contributing Guidelines before opening a PR or submitting new scan modules.

⚠️ Disclaimer

This tool is provided strictly for educational purposes, authorized security research, and defensive OSINT investigations. The developers assume no liability and are not responsible for any misuse, unintended consequences, or legal actions resulting from the deployment of this software.

user-scanner (kaifcodec/user-scanner)

ethical-hacking
Searching Database…

5.4K ·GitHub
User-scanner
What is this?User Scanner is an OSINT (open-source intelligence) CLI tool that takes an email address or username and scans it across 2720+ platforms (210+ email vectors, 2510+ username vectors) to map digital footprints, scrape profile metadata, and surface linked accounts.
Is it a CLI tool or something I call from code?It's primarily a command-line tool, but it also includes a Python library mode for calling the scanning engine programmatically, and an MCP server so AI agents like Claude Desktop or Cursor can run scans themselves.
How do I install and run it?Install it via PyPI (recommended), set it up in a virtual environment, or install via Nix on Linux/macOS, then run it against a single username or email across all available modules.
What does it rely on under the hood for scanning?It's built on Python and uses httpx and curlcffi for high-concurrency requests with automated TLS fingerprint impersonation to avoid detection.
Why would a scan ever fail or need proxies?Target sites constantly change their auth flows, so modules can break over time; the tool has built-in proxy rotation with health validation (--validate-proxies) to work around rate limits and regional blocks.
Who is this built for?Security researchers, red teamers, penetration testers, and OSINT investigators doing authorized digital footprinting and breach correlation work.
Does it run on Windows too?It's a Python package installable via PyPI anywhere Python runs; the Nix install path is explicitly called out for Linux and macOS only.
Is there a legal/ethical catch to using this?The tool is explicitly provided only for educational purposes and authorized security research; the developers disclaim liability for misuse.
What does --cross-scan actually do?It mines handles, profile links, and secondary emails exposed on a target's discovered profiles, then automatically pivots into a second round of scans across those newly found identifiers for deeper reconnaissance.
What is the --hudson flag for?It queries Hudson Rock's infostealer malware breach logs to check if a target username or email has shown up in infected machine data, useful for high-priority breach correlation.
Can AI agents like Claude use this directly?Yes, user-scanner ships a native MCP server exposing scan-username, scan-email, and list-available-modules tools so agents in Claude Desktop, Cursor, or Antigravity can run autonomous OSINT investigations and pivots.
What report formats can I export?Scans can be exported to PDF (including profile photos), JSON, and CSV for further pipeline integration.
What are similar projects?maigret, spiderfoot, Anthropic-Cybersecurity-Skills, Claude-Red, dsh-redteam-model, awesome-osint, redamon, awesome-hacker-search-engines
Which topics is it in?redteaming, osint-tools, osint-tool, threat-intelligence, ethical-hacking, infosec, osint, pentesting, cybersecurity, security-tools, mcp, security
Creator
kaifcodec
Size
2.5 MB
Stars
5.4K
Updated
CommitOct 18Releasev1.5.2Sep 17
Age
1y
Commits · 90 Days