From 173ae5b824fa93cd707810e03bb180fe7a3c1e12 Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha <27065646+sdushantha@users.noreply.github.com> Date: Sun, 12 Apr 2026 17:35:14 +0200 Subject: [PATCH] Update usage --- docs/README.md | 38 ++++++++++++++------------------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/README.md b/docs/README.md index dda36076..56167fd1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -51,51 +51,41 @@ Accounts found will be stored in an individual text file with the corresponding ```console $ sherlock --help -usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT] - [--output OUTPUT] [--tor] [--unique-tor] [--csv] [--xlsx] - [--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE] - [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color] - [--browse] [--local] [--nsfw] +usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT] [--output OUTPUT] [--csv] [--xlsx] [--site SITE_NAME] [--proxy PROXY_URL] [--dump-response] + [--json JSON_FILE] [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color] [--browse] [--local] [--nsfw] [--txt] [--ignore-exclusions] USERNAMES [USERNAMES ...] -Sherlock: Find Usernames Across Social Networks (Version 0.14.3) +Sherlock: Find Usernames Across Social Networks (Version 0.16.0) positional arguments: - USERNAMES One or more usernames to check with social networks. - Check similar usernames using {?} (replace to '_', '-', '.'). + USERNAMES One or more usernames to check with social networks. Check similar usernames using {?} (replace to '_', '-', '.'). -optional arguments: +options: -h, --help show this help message and exit --version Display version information and dependencies. --verbose, -v, -d, --debug Display extra debugging information and metrics. --folderoutput FOLDEROUTPUT, -fo FOLDEROUTPUT - If using multiple usernames, the output of the results will be - saved to this folder. + If using multiple usernames, the output of the results will be saved to this folder. --output OUTPUT, -o OUTPUT - If using single username, the output of the result will be saved - to this file. - --tor, -t Make requests over Tor; increases runtime; requires Tor to be - installed and in system path. - --unique-tor, -u Make requests over Tor with new Tor circuit after each request; - increases runtime; requires Tor to be installed and in system - path. + If using single username, the output of the result will be saved to this file. --csv Create Comma-Separated Values (CSV) File. - --xlsx Create the standard file for the modern Microsoft Excel - spreadsheet (xlsx). - --site SITE_NAME Limit analysis to just the listed sites. Add multiple options to - specify more than one site. + --xlsx Create the standard file for the modern Microsoft Excel spreadsheet (xlsx). + --site SITE_NAME Limit analysis to just the listed sites. Add multiple options to specify more than one site. --proxy PROXY_URL, -p PROXY_URL Make requests over a proxy. e.g. socks5://127.0.0.1:1080 + --dump-response Dump the HTTP response to stdout for targeted debugging. --json JSON_FILE, -j JSON_FILE - Load data from a JSON file or an online, valid, JSON file. + Load data from a JSON file or an online, valid, JSON file. Upstream PR numbers also accepted. --timeout TIMEOUT Time (in seconds) to wait for response to requests (Default: 60) --print-all Output sites where the username was not found. - --print-found Output sites where the username was found. + --print-found Output sites where the username was found (also if exported as file). --no-color Don't color terminal output --browse, -b Browse to all results on default browser. --local, -l Force the use of the local data.json file. --nsfw Include checking of NSFW sites from default list. + --txt Enable creation of a txt file + --ignore-exclusions Ignore upstream exclusions (may return more false positives) ``` ## Credits