From 719aa8be743f71b95c529272860b9fc65db67e4d Mon Sep 17 00:00:00 2001 From: sandeep <8293321+ehsandeep@users.noreply.github.com> Date: Mon, 21 Oct 2024 03:49:03 +0530 Subject: [PATCH] readme update --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a4e1b5e1..aa25848e 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,12 @@ This will display help for the tool. Here are all the switches it supports. ```console +Usage: + ./httpx [flags] + +Flags: +httpx is a fast and multi-purpose HTTP toolkit that allows running multiple probes using the retryablehttp library. + Usage: ./httpx [flags] @@ -124,7 +130,8 @@ HEADLESS: -ho, -headless-options string[] start headless chrome with additional options -esb, -exclude-screenshot-bytes enable excluding screenshot bytes from json output -ehb, -exclude-headless-body enable excluding headless header from json output - -st, -screenshot-timeout int set timeout for screenshot in seconds (default 10) + -st, -screenshot-timeout value set timeout for screenshot in seconds (default 10s) + -sid, -screenshot-idle value set idle time before taking screenshot in seconds (default 1s) MATCHERS: -mc, -match-code string match response with specified status code (-mc 200,302) @@ -134,24 +141,25 @@ MATCHERS: -mfc, -match-favicon string[] match response with specified favicon hash (-mfc 1494302000) -ms, -match-string string[] match response with specified string (-ms admin) -mr, -match-regex string[] match response with specified regex (-mr admin) - -mcdn, -match-cdn string[] match host with specified cdn provider (google, cloudfront, fastly) + -mcdn, -match-cdn string[] match host with specified cdn provider (cloudfront, fastly, google) -mrt, -match-response-time string match response with specified response time in seconds (-mrt '< 1') -mdc, -match-condition string match response with dsl expression condition EXTRACTOR: -er, -extract-regex string[] display response content with matched regex - -ep, -extract-preset string[] display response content matched by a pre-defined regex (ipv4,mail,url) + -ep, -extract-preset string[] display response content matched by a pre-defined regex (url,ipv4,mail) FILTERS: -fc, -filter-code string filter response with specified status code (-fc 403,401) -fep, -filter-error-page filter response with ML based error page detection + -fd, -filter-duplicates filter out near-duplicate responses (only first response is retained) -fl, -filter-length string filter response with specified content length (-fl 23,33) -flc, -filter-line-count string filter response body with specified line count (-flc 423,532) -fwc, -filter-word-count string filter response body with specified word count (-fwc 423,532) -ffc, -filter-favicon string[] filter response with specified favicon hash (-ffc 1494302000) -fs, -filter-string string[] filter response with specified string (-fs admin) -fe, -filter-regex string[] filter response with specified regex (-fe admin) - -fcdn, -filter-cdn string[] filter host with specified cdn provider (google, cloudfront, fastly) + -fcdn, -filter-cdn string[] filter host with specified cdn provider (cloudfront, fastly, google) -frt, -filter-response-time string filter response with specified response time in seconds (-frt '> 1') -fdc, -filter-condition string filter response with dsl expression condition -strip strips all tags in response. supported formats: html,xml (default html) @@ -234,6 +242,7 @@ DEBUG: -v, -verbose verbose mode -si, -stats-interval int number of seconds to wait between showing a statistics update (default: 5) -nc, -no-color disable colors in cli output + -tr, -trace trace OPTIMIZATIONS: -nf, -no-fallback display both probed protocol (HTTPS and HTTP) @@ -248,8 +257,9 @@ OPTIMIZATIONS: CLOUD: -auth configure projectdiscovery cloud (pdcp) api key (default true) - -ac, -auth-config string configure projectdiscovery cloud (pdcp) api key credential file + -ac, -auth-config string configure projectdiscovery cloud (pdcp) api key credential file -pd, -dashboard upload / view output in projectdiscovery cloud (pdcp) UI dashboard + -tid, -team-id string upload asset results to given team id (optional) -aid, -asset-id string upload new assets to existing asset id (optional) -aname, -asset-name string assets group name to set (optional) -pdu, -dashboard-upload string upload httpx output file (jsonl) in projectdiscovery cloud (pdcp) UI dashboard