feat: add optional web UI with live scan progress#2883
Open
lbrezende wants to merge 1 commit into
Open
Conversation
Adds sherlock_project/web.py, a lightweight Flask wrapper around the CLI that streams scan progress to the browser. Users get continuous visual feedback during a run instead of waiting in silence for the full scan to complete. Three display modes: - Found: lists only matched profiles - Live (default): streams matches inline, misses as red dashes - Full log: complete raw output Also includes EN/PT-BR localization with browser auto-detection, hit/miss counters, and line-by-line streaming. Flask is an optional dependency, loaded lazily with a friendly install hint. The core CLI is untouched. Run with: python -m sherlock_project.web
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an optional Flask web UI that surfaces Sherlock's scan progress visually, so users see continuous feedback during a run instead of waiting in silence for the full scan to finish.
Why
A default Sherlock scan checks ~400 sites and takes 1–2 minutes. First-time users often can't tell whether the tool is working, stuck, or done — especially when
--print-foundstays silent until a match lands. This adds a lightweight, opt-in view to close that feedback gap without touching the CLI.What's in it
A single-file module (
sherlock_project/web.py) wrapping the CLI, with three display modes:Plus:
How to run
```bash
pip install flask
python -m sherlock_project.web
http://127.0.0.1:5000
```
Host and port can be overridden with `SHERLOCK_WEB_HOST` and `SHERLOCK_WEB_PORT`.
Notes
Happy to adjust scope, placement, or styling based on maintainer preferences.