> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/qeeqbox/social-analyzer/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get started with Social Analyzer in minutes

This guide will help you run your first profile search with Social Analyzer.

## Prerequisites

Before you begin, make sure you have one of the following installed:

<Tabs>
  <Tab title="Node.js">
    * Node.js 20.18.1 or higher
    * npm (comes with Node.js)
    * Firefox ESR or Chrome browser
    * Tesseract OCR (optional, for advanced detection)
  </Tab>

  <Tab title="Python">
    * Python 3.6 or higher
    * pip (Python package manager)
  </Tab>

  <Tab title="Docker">
    * Docker 20.10 or higher
    * Docker Compose (optional)
  </Tab>
</Tabs>

## Installation

<Steps>
  <Step title="Install Social Analyzer">
    Choose your preferred installation method:

    <CodeGroup>
      ```bash Node.js theme={null}
      # Clone the repository
      git clone https://github.com/qeeqbox/social-analyzer.git
      cd social-analyzer

      # Install dependencies
      npm install
      ```

      ```bash Python (PyPI) theme={null}
      # Install from PyPI
      pip3 install social-analyzer
      ```

      ```bash Python (Source) theme={null}
      # Clone and install from source
      git clone https://github.com/qeeqbox/social-analyzer.git
      cd social-analyzer
      pip3 install -r requirements.txt
      ```

      ```bash Docker theme={null}
      # Pull the Docker image
      docker pull qeeqbox/social-analyzer
      ```
    </CodeGroup>
  </Step>

  <Step title="Verify Installation">
    Test that Social Analyzer is working:

    <CodeGroup>
      ```bash Node.js theme={null}
      node app.js --list
      ```

      ```bash Python theme={null}
      python3 -m social-analyzer --list
      ```

      ```bash Docker theme={null}
      docker run qeeqbox/social-analyzer --list
      ```
    </CodeGroup>

    This should display a list of supported websites.
  </Step>
</Steps>

## Your First Search

Let's run a basic username search:

<CodeGroup>
  ```bash Node.js theme={null}
  node app.js --username "johndoe"
  ```

  ```bash Python theme={null}
  python3 -m social-analyzer --username "johndoe"
  ```

  ```bash Docker theme={null}
  docker run qeeqbox/social-analyzer --username "johndoe"
  ```
</CodeGroup>

This will search for the username "johndoe" across all 1000+ supported social media websites using the **fast** detection mode.

<Note>
  The first search may take a few minutes as Social Analyzer checks each website. Subsequent searches are typically faster.
</Note>

## Understanding the Output

Social Analyzer displays results with confidence ratings:

* **Good** (100%): High confidence - profile definitely exists
* **Maybe** (50-99%): Medium confidence - profile likely exists
* **Bad** (Below 50%): Low confidence - uncertain or false positive

Example output:

```bash theme={null}
[Detected] YouTube - https://youtube.com/@johndoe (Rate: 100%)
[Detected] Twitter - https://twitter.com/johndoe (Rate: 85%)
[Maybe] Instagram - https://instagram.com/johndoe (Rate: 65%)
```

## Common Use Cases

### Search Specific Websites

If you only want to check specific platforms:

```bash theme={null}
node app.js --username "johndoe" --websites "youtube twitter instagram"
```

### Search Top-Ranked Sites

Focus on the most popular websites for faster results:

```bash theme={null}
node app.js --username "johndoe" --top 50
```

### Extract Metadata

Get additional profile information and metadata:

```bash theme={null}
node app.js --username "johndoe" --metadata --extract
```

### JSON Output

Get machine-readable output for integration with other tools:

```bash theme={null}
node app.js --username "johndoe" --output json
```

## Web Interface

Social Analyzer also provides a web-based GUI:

<Steps>
  <Step title="Start the Web Server">
    ```bash theme={null}
    node app.js --gui
    ```
  </Step>

  <Step title="Open in Browser">
    Navigate to `http://localhost:9005/app.html` in your web browser
  </Step>

  <Step title="Enter Username">
    Type a username in the search box and click "Find"
  </Step>

  <Step title="View Results">
    Results will appear with confidence ratings, and you can filter by quality (good/maybe/bad)
  </Step>
</Steps>

## Next Steps

Now that you've run your first search, explore more features:

<CardGroup cols={2}>
  <Card title="Detection Modes" icon="magnifying-glass" href="/features/detection-modes">
    Learn about fast, slow, and special detection modes
  </Card>

  <Card title="Configuration Options" icon="sliders" href="/configuration/options">
    Customize Social Analyzer with advanced options
  </Card>

  <Card title="Metadata Extraction" icon="database" href="/features/metadata-extraction">
    Extract detailed information from profiles
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/api/cli-reference">
    Complete command-line reference
  </Card>
</CardGroup>

## Tips for Better Results

<Tip>
  **Use specific usernames**: Social Analyzer works best with exact usernames rather than common names or partial matches.
</Tip>

<Tip>
  **Filter results**: Use `--filter good` to only see high-confidence matches and reduce false positives.
</Tip>

<Tip>
  **Search by region**: Use `--countries` to focus on websites popular in specific regions for faster, more relevant results.
</Tip>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Search is taking too long">
    Try using `--top 50` to limit searches to top-ranked websites, or use `--mode fast` (default) instead of slow mode.
  </Accordion>

  <Accordion title="Getting too many false positives">
    Use `--filter good` to only show high-confidence matches, or use `--mode slow` for more accurate detection.
  </Accordion>

  <Accordion title="Browser/WebDriver errors">
    Make sure Firefox ESR or Chrome is installed. For Node.js, geckodriver is installed automatically with npm. For Python, you may need to install it separately.
  </Accordion>

  <Accordion title="Rate limiting or blocked requests">
    Use `--proxy` with a proxy server, or reduce the number of concurrent requests. Some websites have rate limiting and may temporarily block requests.
  </Accordion>
</AccordionGroup>

Need more help? Check the [Troubleshooting Guide](/resources/troubleshooting) or [FAQ](/resources/faq).