Skip to main content
The Node.js CLI provides a fast command-line interface for analyzing user profiles across social media platforms. It supports the same detection capabilities as the web interface but is optimized for automation and scripting.

​
Prerequisites

1

Install Node.js

Ensure Node.js (version >13) is installed on your system.
2

Clone the repository

git clone https://github.com/qeeqbox/social-analyzer.git
cd social-analyzer
3

Install dependencies

npm install

​
Basic Usage

Search for a single username across all supported websites: 
node app.js --username "johndoe"

​
Multiple Usernames

Search for multiple usernames simultaneously (separated by commas): 
node app.js --username "johndoe,janedoe"

​
CLI Arguments

​
Required Arguments

ArgumentDescriptionExample
--usernameUsername(s) to search for"johndoe" or "johndoe,janedoe"

​
Website Selection

node app.js --username "johndoe" --websites "all"
Searches across all available platforms (default behavior).

​
Analysis Mode

ModeFlagDescription
Fast (default)--mode fastUses FindUserProfilesFast - quick analysis
Slow--mode slowUses FindUserProfilesSlow - deep analysis
Special--mode specialUses FindUserProfilesSpecial - special detections
node app.js --username "johndoe" --mode fast

​
Detection Method

node app.js --username "johndoe" --method all
  • all - Combines find and get methods
  • find - Shows only detected profiles
  • get - Shows all profiles regardless of detection

​
Output Format

node app.js --username "johndoe" --output pretty
Human-readable colored output in the terminal.

​
Filtering Results

​
Filter by Profile Quality

# Show only good matches
node app.js --username "johndoe" --filter "good"

# Show good and maybe matches
node app.js --username "johndoe" --filter "good,maybe"

# Show all results
node app.js --username "johndoe" --filter "all"
Available filters:
  • good - High confidence matches (default)
  • maybe - Moderate confidence matches
  • bad - Low confidence matches
  • all - All matches

​
Filter by Profile Status

# Show only detected profiles
node app.js --username "johndoe" --profiles "detected"

# Show detected and failed profiles
node app.js --username "johndoe" --profiles "detected,failed"

# Show all profile statuses
node app.js --username "johndoe" --profiles "all"
Available profile types:
  • detected - Successfully detected profiles (default)
  • unknown - Profiles with uncertain status
  • failed - Failed checks

​
Advanced Features

​
Extract Additional Data

# Extract patterns (URLs, emails, etc.)
node app.js --username "johndoe" --extract

# Extract metadata from profile pages
node app.js --username "johndoe" --metadata

# Combine both
node app.js --username "johndoe" --extract --metadata

​
Geographic Filtering

# Filter by country codes (space-separated)
node app.js --username "johndoe" --countries "us br ru"

​
Category Filtering

# Filter by website type
node app.js --username "johndoe" --type "Music"
node app.js --username "johndoe" --type "Adult"

​
Customize Output Fields

# Show specific fields only
node app.js --username "johndoe" --options "link,rate,title"
Available options:
  • link - Profile URL
  • rate - Detection confidence percentage
  • title - Page title
  • text - Extracted text content

​
Trim Long Strings

node app.js --username "johndoe" --trim
Truncates long text fields to 50 characters for cleaner output.

​
Complete Examples

node app.js --username "johndoe"

​
Listing Available Websites

To see all supported websites: 
node app.js --list
This displays a list of all 900+ supported social media platforms.

​
Output Examples

​
Pretty Output

node app.js --username "johndoe" --output pretty

[init] Detections are updated very often, make sure to get the most up-to-date ones
[init] NodeJS Version Check
-----------------------
link         : https://twitter.com/johndoe
rate         : %100.00
status       : good
title        : John Doe (@johndoe) / Twitter
language     : English
-----------------------

​
JSON Output

node app.js --username "johndoe" --output json

{
  "detected": [
    {
      "link": "https://twitter.com/johndoe",
      "rate": "%100.00",
      "status": "good",
      "title": "John Doe (@johndoe) / Twitter",
      "language": "English",
      "type": "Social Network",
      "country": "us",
      "rank": "5"
    }
  ]
}
The Node.js CLI is limited to FindUserProfilesFast mode. For advanced detection modes (slow and special), use the Python CLI or web interface.

​
Performance Tips

  • Use --top to limit searches to top-ranked websites for faster results
  • Use --websites to search only specific platforms when you know where to look
  • Use --filter "good" to reduce false positives
  • Use --output json for easier parsing in scripts
  • The tool checks websites with randomized delays (1-99ms) to avoid rate limiting

​
Troubleshooting

Node.js version error Ensure you’re running Node.js version 13 or higher: 
node --version
No results found Try different variations of the username or use the web interface for more advanced detection options. Rate limiting If you encounter rate limiting, reduce the number of websites checked or use --top with a lower number.

Build docs developers (and LLMs) love

Get started for freeTalk to us