Skip to content

Commit b56ecdb

Browse files
authored
Merge pull request goadapp#170 from cwaltken-edrans/update_readme
goadapp#163 Fix cli help text in readme
2 parents 2ea622b + 02f7989 commit b56ecdb

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -63,31 +63,27 @@ Goad will read your credentials from `~/.aws/credentials` or from the `AWS_ACCES
6363
```sh
6464
# Get help:
6565
$ goad --help
66-
usage: goad [<flags>] <url>
66+
usage: goad [<flags>] [<url>]
6767

6868
An AWS Lambda powered load testing tool
6969

7070
Flags:
7171
-h, --help Display usage information (this message)
72-
-n, --requests=1000 Number of requests to perform. Set to 0 in
73-
combination with a specified timelimit allows
74-
for unlimited requests for the specified time.
72+
-n, --requests=2000 Number of requests to perform. Set to 0 in combination with a specified timelimit allows for unlimited requests for the specified time.
7573
-c, --concurrency=10 Number of multiple requests to make at a time
7674
-t, --timelimit=3600 Seconds to max. to spend on benchmarking
7775
-s, --timeout=15 Seconds to max. wait for each response
78-
-H, --header=HEADER ... Add Arbitrary header line, eg.
79-
'Accept-Encoding: gzip' (repeatable)
80-
--region=us-east-1... ... AWS regions to run in. Repeat flag to run in
81-
more then one region. (repeatable)
82-
--output-json=OUTPUT-JSON Optional path to file for JSON result storage
76+
-H, --header=HEADER ... Add Arbitrary header line, eg. 'Accept-Encoding: gzip' (repeatable)
8377
-m, --method="GET" HTTP method
8478
--body=BODY HTTP request body
85-
--create-ini-template create sample configuration file "goad.ini"
86-
in current working directory
79+
--json-output=JSON-OUTPUT Optional path to file for JSON result storage
80+
--region=us-east-1 ... AWS regions to run in. Repeat flag to run in more then one region. (repeatable)
81+
--run-docker execute in docker container instead of aws lambda
82+
--create-ini-template create sample configuration file "goad.ini" in current working directory
8783
-V, --version Show application version.
8884

8985
Args:
90-
<url> [http[s]://]hostname[:port]/path optional if defined in goad.ini
86+
[<url>] [http[s]://]hostname[:port]/path optional if defined in goad.ini
9187

9288
# For example:
9389
$ goad -n 1000 -c 5 -u https://example.com

0 commit comments

Comments
 (0)