CLI Reference

Complete command-line interface reference for Social Analyzer

Overview

Social Analyzer provides powerful CLI tools for both Node.js and Python implementations. Both CLIs offer the same functionality with slightly different syntax.

Node.js CLI

Installation

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

Basic Usage

node app.js --username "johndoe" --websites "youtube tiktok"
node app.js --username "johndoe"

Command Line Arguments

--username · string · default: ""

Username to search for. Examples: johndoe, john_doe, or johndoe9999

--websites · string · default: "all"

Target websites separated by spaces. Examples: youtube, tiktok tumblr, or all for all websites

--mode · string · default: "fast"

Analysis mode:

• fast - FindUserProfilesFast (quick scan)
• slow - FindUserProfilesSlow (deep analysis)
• special - FindUserProfilesSpecial (specialized detection)

--output · string · default: "pretty"

Output format:

• json - JSON output for integration
• pretty - Human-readable formatted output

--options · string · default: ""

Display options when profile is found (comma-separated): link, rate, title, text

--method · string · default: "all"

Search method:

• find - Show only detected profiles
• get - Show all profiles regardless of detection
• all - Combine find & get methods

--filter · string · default: "good"

Filter detected profiles by confidence level. Options: good, maybe, bad, or combine with comma: good,bad, or use all

--profiles · string · default: "detected"

Filter profiles by status. Options: detected, unknown, failed, or combine: detected,failed, or use all

--top · string · default: "0"

Select top N websites by popularity (e.g., 10, 50). When used, --websites is not needed.

--type · string · default: "all"

Filter websites by category (e.g., Adult, Music)

--countries · string · default: "all"

Filter websites by country codes separated by spaces (e.g., us br ru)

--extract · boolean · default: "false"

Extract profiles, URLs, and patterns from detected profiles

--metadata · boolean · default: "false"

Extract metadata using QeeqBox OSINT (requires pypi package)

--trim · boolean · default: "false"

Trim long strings in output

--list · boolean · default: "false"

List all available websites and exit

--gui · boolean · default: "false"

Reserved for GUI mode (not fully implemented)

--cli · boolean · default: "false"

Reserved for CLI mode (deprecated, not needed)

--docker · boolean · default: "false"

Enable Docker compatibility mode

--grid · string · default: ""

Grid display option (for web interface, not CLI)

Examples

Basic Search

node app.js --username "johndoe"

---

Python CLI

Installation

pip install social-analyzer

Basic Usage

python -m social-analyzer --username "johndoe"
social-analyzer --username "johndoe" --websites "youtube tiktok"

Command Line Arguments

The Python CLI supports the same arguments as Node.js with these additional options:

--username · string · default: "" · required

Username to search for. Examples: johndoe, john_doe, or johndoe9999

--websites · string · default: "all"

Target websites separated by spaces. Examples: youtube, tiktok tumblr, or all

--mode · string · default: "fast"

Analysis mode: fast, slow, or special

--output · string · default: "pretty"

Output format: json or pretty

--options · string · default: ""

Display fields: link, rate, title, text

--method · string · default: "all"

Search method: find, get, or all

--filter · string · default: "good"

Filter by confidence: good, maybe, bad, good,bad, or all

--profiles · string · default: "detected"

Filter by status: detected, unknown, failed, detected,failed, or all

--countries · string · default: "all"

Country filter: space-separated codes (e.g., us br ru)

--type · string · default: "all"

Website category filter (e.g., Adult, Music)

--top · string · default: "0"

Select top N websites by rank (e.g., 10, 50)

--extract · boolean

Extract profiles, URLs, and patterns

--metadata · boolean

Extract metadata using QeeqBox OSINT

--trim · boolean

Trim long strings in output

--list · boolean

List all available websites

--screenshots · boolean

Capture screenshots of detected profiles (requires --logs)

--simplify · boolean

Print only detected profile links (simplified output)

--gui · boolean

Reserved for GUI mode (not implemented)

--cli · boolean

Reserved for CLI mode (deprecated)

Settings Arguments

--headers · json · default: "{}"

Custom HTTP headers as JSON dictionary

--headers '{"User-Agent": "Custom Agent"}'

--logs · boolean

Enable logging to file

--logs_dir · string · default: ""

Custom directory for log files

--timeout · integer · default: "0"

Delay in seconds between requests (0 = random delay 0.01-0.99s)

--silent · boolean

Disable all console output (useful for scripting)

Python CLI Examples

Basic Search

python -m social-analyzer --username "johndoe"

---

Common Workflows

List Available Websites

# Node.js
social-analyzer --list

# Python
python -m social-analyzer --list

Quick Search with JSON Output

social-analyzer --username "johndoe" --output json > results.json

Deep Analysis with Metadata

social-analyzer --username "johndoe" --mode slow --extract --metadata

Search Specific Region

social-analyzer --username "johndoe" --countries "us" --top 100

High Confidence Results Only

social-analyzer --username "johndoe" --filter good --profiles detected

---

Exit Codes

• 0 - Success
• 2 - Argument parsing error
• Other non-zero values indicate errors during execution

Notes

The --cli flag is deprecated and will be removed in future versions. It’s not needed for CLI operation.

Using --metadata requires the QeeqBox OSINT package to be installed separately.

For automation and scripting, use --output json --silent to get clean JSON output without log messages.