🕵️‍♂️ Sherlock

Check social media accounts usernames

A serverless username search tool powered by Cloudflare Workers and Containers. Search for a username across hundreds of social media platforms instantly.

Tech Stack

• Frontend: Hono with JSX
• Runtime: Cloudflare Workers
• Backend: Python Flask in Cloudflare Containers
• Validation: Zod schemas
• Styling: TailwindCSS
• Code Quality: Biome

Getting Started

Prerequisites

• Bun or Node.js
• Wrangler CLI
• Cloudflare account with Workers and Container access

Installation

# Install dependencies
bun install

# Generate TypeScript types
bun run cf-typegen

Development

# Start local development server
bun run dev

Visit http://localhost:8787 to access the application.

Deployment

# Deploy to Cloudflare Workers
bun run deploy

Usage

Web Interface

Navigate to the deployed URL and enter a username to search.

API

Search for a username programmatically:

curl https://sherlock.nuro.dev/your_username_here \
  -H "Accept: application/json"

Response format:

{
  "data": {
    "GitHub": {
      "status": "found",
      "url": "https://github.com/username"
    },
    "Twitter": {
      "status": "found",
      "url": "https://twitter.com/username"
    }
  },
  "error": null
}

Code Quality

# Format code
bun run format

# Lint and auto-fix
bun run lint

# Check without fixing
bun run check

License

See LICENSE file for details.

Acknowledgments

💙 Powered by sherlock-project/sherlock