Skip to content

Commit c962dda

Browse files
committed
readme updates
1 parent 42f9675 commit c962dda

File tree

2 files changed

+48
-41
lines changed

2 files changed

+48
-41
lines changed

README.md

Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -48,34 +48,41 @@ httpx -h
4848

4949
This will display help for the tool. Here are all the switches it supports.
5050

51-
| Flag | Description | Example |
52-
|------------------------ |-------------------------------------------------------|----------------------------------------------------|
53-
| -H | Custom Header input | httpx -H 'x-bug-bounty: hacker' |
54-
| -follow-redirects | Follow URL redirects (default false) | httpx -follow-redirects |
55-
| -follow-host-redirects | Follow URL redirects only when staying on the same host (default false) | httpx -follow-host-redirects|
56-
| -http-proxy | URL of the proxy server | httpx -http-proxy hxxp://proxy-host:80 |
57-
| -l | File containing host/urls to process | httpx -l hosts.txt |
58-
| -l | File containing CIDR to process | httpx -l cidr.txt |
59-
| -no-color | Disable colors in the output. | httpx -no-color |
60-
| -o | File to save output result (optional) | httpx -o output.txt |
61-
| -json | Prints all the probes in JSON format (default false) | httpx -json |
62-
| -vhost | Probes to detect vhost from list of subdomains | httpx -vhost |
63-
| -threads | Number of threads (default 50) | httpx - threads 100 |
64-
| -ports | Ports ranges to probe (nmap syntax: eg 1,2-10,11) | httpx -ports 80,443,100-200 |
65-
| -title | Prints title of page if available | httpx -title |
66-
| -content-length | Prints content length in the output | httpx -content-length |
67-
| -status-code | Prints status code in the output | httpx -status-code |
68-
| -web-server | Prints running web sever if available | httpx -web-server |
69-
| -store-response | Store response as domain.txt | httpx -store-response |
70-
| -store-response-dir| Directory to store response (default current path) | httpx -store-response-dir output |
71-
| -retries | Number of retries | httpx -retries |
72-
| -silent | Prints only results in the output | httpx -silent |
73-
| -timeout | Timeout in seconds (default 5) | httpx -timeout 10 |
74-
| -verbose | Verbose Mode | httpx -verbose |
75-
| -version | Prints current version of the httpx | httpx -version |
76-
| -x | Request Method (default 'GET') | httpx -x HEAD |
77-
| -response-in-json | Include response in stdout (only works with -json) | httpx -response-in-json |
78-
| -websocket | Prints if a websocket is exposed | httpx -websocket |
51+
| Flag | Description | Example |
52+
|------------------------ |------------------------------------------------------- |----------------------------------------------------|
53+
| -H | Custom Header input | httpx -H 'x-bug-bounty: hacker' |
54+
| -follow-redirects | Follow URL redirects (default false) | httpx -follow-redirects |
55+
| -follow-host-redirects | Follow URL redirects only on same host(default false) | httpx -follow-host-redirects |
56+
| -http-proxy | URL of the proxy server | httpx -http-proxy hxxp://proxy-host:80 |
57+
| -l | File containing host/urls to process | httpx -l hosts.txt |
58+
| -l | File containing CIDR to process | httpx -l cidr.txt |
59+
| -no-color | Disable colors in the output. | httpx -no-color |
60+
| -o | File to save output result (optional) | httpx -o output.txt |
61+
| -json | Prints all the probes in JSON format (default false) | httpx -json |
62+
| -vhost | Probes to detect vhost from list of subdomains | httpx -vhost |
63+
| -threads | Number of threads (default 50) | httpx -threads 100 |
64+
| -ports | Ports ranges to probe (nmap syntax: eg 1,2-10,11) | httpx -ports 80,443,100-200 |
65+
| -title | Prints title of page if available | httpx -title |
66+
| -path | Request path/file | httpx -path /api |
67+
| -content-length | Prints content length in the output | httpx -content-length |
68+
| -ml | Match content length in the output | httpx -content-length -ml 125 |
69+
| -fl | Filter content length in the output | httpx -content-length -fl 0,43 |
70+
| -status-code | Prints status code in the output | httpx -status-code |
71+
| -mc | Match status code in the output | httpx -status-code -mc 200,302 |
72+
| -fc | Filter status code in the output | httpx -status-code -fc 404,500 |
73+
| -tls-probe | Send HTTP probes on the extracted TLS domains | httpx -tls-probe |
74+
| -content-type | Prints content-type | httpx -content-type |
75+
| -web-server | Prints running web sever if available | httpx -web-server |
76+
| -sr | Store response as domain.txt | httpx -store-response |
77+
| -srd | Directory to store response (default current path) | httpx -store-response-dir output |
78+
| -retries | Number of retries | httpx -retries |
79+
| -silent | Prints only results in the output | httpx -silent |
80+
| -timeout | Timeout in seconds (default 5) | httpx -timeout 10 |
81+
| -verbose | Verbose Mode | httpx -verbose |
82+
| -version | Prints current version of the httpx | httpx -version |
83+
| -x | Request Method (default 'GET') | httpx -x HEAD |
84+
| -response-in-json | Include response in stdout (only works with -json) | httpx -response-in-json |
85+
| -websocket | Prints if a websocket is exposed | httpx -websocket |
7986

8087

8188
# Installation Instructions
@@ -87,7 +94,7 @@ The installation is easy. You can download the pre-built binaries for your platf
8794

8895
```bash
8996
> tar -xvf httpx-linux-amd64.tar
90-
> mv httpx-linux-amd64 /usr/bin/httpx
97+
> mv httpx-linux-amd64 /usr/local/bin/httpx
9198
> httpx -h
9299
```
93100

cmd/httpx/httpx.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -470,32 +470,32 @@ func ParseOptions() *Options {
470470
flag.StringVar(&options.Output, "o", "", "File to write output to (optional)")
471471
flag.BoolVar(&options.VHost, "vhost", false, "Check for VHOSTs")
472472
flag.BoolVar(&options.ExtractTitle, "title", false, "Extracts title")
473-
flag.BoolVar(&options.StatusCode, "status-code", false, "Extracts Status Code")
473+
flag.BoolVar(&options.StatusCode, "status-code", false, "Extracts status code")
474474
flag.Var(&options.CustomHeaders, "H", "Custom Header")
475475
flag.Var(&options.CustomPorts, "ports", "ports range (nmap syntax: eg 1,2-10,11)")
476-
flag.BoolVar(&options.ContentLength, "content-length", false, "Content Length")
477-
flag.BoolVar(&options.StoreResponse, "sr", false, "Store Response as domain.txt")
478-
flag.StringVar(&options.StoreResponseDir, "srd", "output", "Store Response Directory (default 'output directory)")
476+
flag.BoolVar(&options.ContentLength, "content-length", false, "Extracts content length")
477+
flag.BoolVar(&options.StoreResponse, "sr", false, "Save response to file (default 'output')")
478+
flag.StringVar(&options.StoreResponseDir, "srd", "output", "Save response directory")
479479
flag.BoolVar(&options.FollowRedirects, "follow-redirects", false, "Follow Redirects")
480480
flag.BoolVar(&options.FollowHostRedirects, "follow-host-redirects", false, "Only follow redirects on the same host")
481-
flag.StringVar(&options.HttpProxy, "http-proxy", "", "Http Proxy, eg http://127.0.0.1:8080")
481+
flag.StringVar(&options.HttpProxy, "http-proxy", "", "HTTP Proxy, eg http://127.0.0.1:8080")
482482
flag.BoolVar(&options.JSONOutput, "json", false, "JSON Output")
483483
flag.StringVar(&options.InputFile, "l", "", "File containing domains")
484484
flag.StringVar(&options.Method, "x", "GET", "Request Method")
485485
flag.BoolVar(&options.Silent, "silent", false, "Silent mode")
486486
flag.BoolVar(&options.Version, "version", false, "Show version of httpx")
487487
flag.BoolVar(&options.Verbose, "verbose", false, "Verbose Mode")
488488
flag.BoolVar(&options.NoColor, "no-color", false, "No Color")
489-
flag.BoolVar(&options.OutputServerHeader, "web-server", false, "Prints out the Server header content")
489+
flag.BoolVar(&options.OutputServerHeader, "web-server", false, "Extracts server header")
490490
flag.BoolVar(&options.OutputWebSocket, "websocket", false, "Prints out if the server exposes a websocket")
491491
flag.BoolVar(&options.responseInStdout, "response-in-json", false, "Server response directly in the tool output (-json only)")
492492
flag.BoolVar(&options.TLSProbe, "tls-probe", false, "Send HTTP probes on the extracted TLS domains")
493-
flag.StringVar(&options.RequestURI, "path", "", "Request Path")
494-
flag.BoolVar(&options.OutputContentType, "content-type", false, "Prints out the Content-Type header value")
495-
flag.StringVar(&options.OutputMatchStatusCode, "mc", "", "match status code")
496-
flag.StringVar(&options.OutputMatchStatusCode, "ml", "", "match content length")
497-
flag.StringVar(&options.OutputFilterStatusCode, "fc", "", "filter status code")
498-
flag.StringVar(&options.OutputFilterContentLength, "fl", "", "filter content length")
493+
flag.StringVar(&options.RequestURI, "path", "", "Request path/file (example '/api')")
494+
flag.BoolVar(&options.OutputContentType, "content-type", false, "Extracts content-type")
495+
flag.StringVar(&options.OutputMatchStatusCode, "mc", "", "Match status code")
496+
flag.StringVar(&options.OutputMatchStatusCode, "ml", "", "Match content length")
497+
flag.StringVar(&options.OutputFilterStatusCode, "fc", "", "Filter status code")
498+
flag.StringVar(&options.OutputFilterContentLength, "fl", "", "Filter content length")
499499
flag.Parse()
500500

501501
// Read the inputs and configure the logging

0 commit comments

Comments
 (0)