DEV Community

Cover image for user-scanner a cli tool written in python which helps you choose a unique username across all popular sites and games ⚑
kaifcodec
kaifcodec

Posted on

user-scanner a cli tool written in python which helps you choose a unique username across all popular sites and games ⚑

πŸš€ User Scanner: Find Your Perfect Username Across All Platforms in Seconds ⚑

Tired of opening tabs and hunting site-by-site to see if your favorite username is taken?

user-scanner fixes that , fast, from your terminal, with clear color-coded output. Perfect for developers, creators, and anyone who wants a consistent online identity without the busywork.


Features

  • βœ… Check usernames across social networks, developer platforms, and creator communities.
  • βœ… Clear Available / Taken / Error output for each platform.
  • βœ… Robust error handling: It prints the exact reason (e.g. Cannot use underscores, hyphens at the start/end)
  • βœ… Fully modular: add new platform modules easily.
  • βœ… Wildcard-based username permutations for automatic variation generation using provided suffix
  • βœ… Command-line interface ready: works directly after pip install
  • βœ… Can be used as username OSINT tool.
  • βœ… Very low and lightweight dependencies, can be run on any machine.

Installation

pip install user-scanner
Enter fullscreen mode Exit fullscreen mode

Usage

Scan a username across all platforms:

user-scanner -u <username>
Enter fullscreen mode Exit fullscreen mode

Optionally, scan a specific category or single module:

user-scanner -u <username> -c dev
user-scanner -l # Lists all available modules
user-scanner -u <username> -m github
user-scanner -u <username> -p <suffix> 

Enter fullscreen mode Exit fullscreen mode

Generate multiple username variations by appending a suffix:

user-scanner -u <username> -p <suffix> 

Enter fullscreen mode Exit fullscreen mode

Optionally, scan a specific category or single module with limit:

user-scanner -u <username> -p <suffix> -c dev
user-scanner -u <username> -p <suffix> -m github
user-scanner -u <username> -p <suffix> -s <number> # limit generation of usernames
user-scanner -u <username> -p <suffix> -d <seconds> #delay to avoid rate-limits
Enter fullscreen mode Exit fullscreen mode

Screenshots:

  • Note*: New modules are constantly getting added so this might have only limited, outdated output:

1000140392


1000140393

Contributing:

Modules are organized by category:

user_scanner/
β”œβ”€β”€ dev/        # Developer platforms (GitHub, GitLab, etc.)
β”œβ”€β”€ social/     # Social platforms (Twitter/X, Reddit, Instagram, etc.)
β”œβ”€β”€ creator/    # Creator platforms (Hashnode, Dev.to, Medium, etc.)
β”œβ”€β”€ community/  # Community platforms (forums, niche sites)
β”œβ”€β”€ gaming/     # Gaming sites (chess.com, roblox, monkeytype etc.)
β”œβ”€β”€ donation/   # Donation taking sites (buymeacoffe.com, similar...)
Enter fullscreen mode Exit fullscreen mode

Module guidelines:
This project contains small "validator" modules that check whether a username exists on a given platform. Each validator is a single function that returns a Result object (see core/orchestrator.py).

Result semantics:

  • Result.available() β†’ available
  • Result.taken() β†’ taken
  • Result.error(message: Optional[str]) β†’ error, blocked, unknown, or request failure (include short diagnostic message when helpful)

Follow this document when adding or updating validators.


Dependencies:


License

This project is licensed under the MIT License.

Top comments (1)

Collapse
 
kaifcodec profile image
kaifcodec

Contributions are always welcome, feel free to check out.