Skip to content

Commit 703fb82

Browse files
authored
Fix CLI args description (#274)
* Fix CLI args description * Update README.md
1 parent 19b7a32 commit 703fb82

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ Supported GoTestWAF configuration options are described below.
363363
Usage: ./gotestwaf [OPTIONS] --url <URL>
364364

365365
Options:
366-
--addDebugHeader Add header with a hash of the test information in each request
366+
--addDebugHeader Add header "X-GoTestWAF-Test" with a hash of the test information in each request
367367
--addHeader string An HTTP header to add to requests
368368
--blockConnReset If present, connection resets will be considered as block
369369
--blockRegex string Regex to detect a blocking page with the same HTTP response status code as a not blocked request
@@ -374,7 +374,7 @@ Options:
374374
--graphqlURL string GraphQL URL to check
375375
--grpcPort uint16 gRPC port to check
376376
--hideArgsInReport If present, GoTestWAF CLI arguments will not be displayed in the report
377-
--httpClient string Which HTTP client use to send requests: gohttp, chrome (default "gohttp")
377+
--httpClient string Which HTTP client use to send requests: chrome, gohttp (default "gohttp")
378378
--idleConnTimeout int The maximum amount of time a keep-alive connection will live (gohttp only) (default 2)
379379
--ignoreUnresolved If present, unresolved test cases will be considered as bypassed (affect score and results)
380380
--includePayloads If present, payloads will be included in HTML/PDF report
@@ -391,7 +391,7 @@ Options:
391391
--quiet If present, disable verbose logging
392392
--randomDelay int Random delay in ms in addition to the delay between requests (default 400)
393393
--renewSession Renew cookies before each test. Should be used with --followCookies flag (gohttp only)
394-
--reportFormat strings Export report in the following formats: json, html, pdf, none (default [pdf])
394+
--reportFormat strings Export report in the following formats: none, json, html, pdf (default [pdf])
395395
--reportName string Report file name. Supports `time' package template format (default "waf-evaluation-report-2006-January-02-15-04-05")
396396
--reportPath string A directory to store reports (default "reports")
397397
--sendDelay int Delay in ms between requests (default 400)

cmd/gotestwaf/flags.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ func parseFlags() (args []string, err error) {
114114
flag.Bool("tlsVerify", false, "If present, the received TLS certificate will be verified")
115115
flag.String("proxy", "", "Proxy URL to use")
116116
flag.String("addHeader", "", "An HTTP header to add to requests")
117-
flag.Bool("addDebugHeader", false, "Add header with a hash of the test information in each request")
117+
flag.Bool("addDebugHeader", false, "Add header \"X-GoTestWAF-Test\" with a hash of the test information in each request")
118118

119119
// GoHTTP client only settings
120120
flag.Int("maxIdleConns", 2, "The maximum number of keep-alive connections (gohttp only)")

0 commit comments

Comments
 (0)