mirror of
https://github.com/Orange-OpenSource/hurl.git
synced 2024-12-24 11:32:00 +03:00
Sort options alphabetically in -h/man.
This commit is contained in:
jcamiel
jcamiel
parent
23e6c87fa0
commit
490e07cade
69
docs/hurl.md
69
docs/hurl.md
@ -117,24 +117,17 @@ Thanks to asserts, Hurl can be used as a testing tool to run scenarii.
|
||||
|
||||
Options that exist in curl have exactly the same semantic.
|
||||
|
||||
### --cacert {#cacert}
|
||||
|
||||
Tells curl to use the specified certificate file to verify the peer.
|
||||
The file may contain multiple CA certificates.
|
||||
The certificate(s) must be in PEM format.
|
||||
Normally curl is built to use a default file for this, so this option is typically used to alter that default file.
|
||||
|
||||
### --color {#color}
|
||||
|
||||
Colorize Output
|
||||
|
||||
### -b, --cookie <file> {#cookie}
|
||||
|
||||
Read cookies from file (using the Netscape cookie file format).
|
||||
|
||||
Combined with [-c, --cookie-jar](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.
|
||||
|
||||
### --cacert {#cacert}
|
||||
|
||||
Tells curl to use the specified certificate file to verify the peer.
|
||||
The file may contain multiple CA certificates.
|
||||
The certificate(s) must be in PEM format.
|
||||
Normally curl is built to use a default file for this, so this option is typically used to alter that default file.
|
||||
|
||||
### --compressed {#compressed}
|
||||
|
||||
Request a compressed response using one of the algorithms br, gzip, deflate and automatically decompress the content.
|
||||
@ -145,6 +138,12 @@ Maximum time in seconds that you allow Hurl's connection to take.
|
||||
|
||||
See also [-m, --max-time](#max-time) option.
|
||||
|
||||
### -b, --cookie <file> {#cookie}
|
||||
|
||||
Read cookies from file (using the Netscape cookie file format).
|
||||
|
||||
Combined with [-c, --cookie-jar](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.
|
||||
|
||||
### -c, --cookie-jar <file> {#cookie-jar}
|
||||
|
||||
Write cookies to FILE after running the session (only for one session).
|
||||
@ -166,6 +165,10 @@ All the input files are executed independently. The result of one file does not
|
||||
Set root filesystem to import files in Hurl. This is used for both files in multipart form data and request body.
|
||||
When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.
|
||||
|
||||
### -L, --location {#location}
|
||||
|
||||
Follow redirect. You can limit the amount of redirects to follow by using the [--max-redirs](#max-redirs) option.
|
||||
|
||||
### --glob <glob> {#glob}
|
||||
|
||||
Specify input files that match the given blob.
|
||||
@ -173,17 +176,17 @@ Specify input files that match the given blob.
|
||||
Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and [].
|
||||
However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.
|
||||
|
||||
### -h, --help {#help}
|
||||
### -i, --include {#include}
|
||||
|
||||
Usage help. This lists all current command line options with a short description.
|
||||
Include the HTTP headers in the output (last entry).
|
||||
|
||||
### --ignore-asserts {#ignore-asserts}
|
||||
|
||||
Ignore all asserts defined in the Hurl file.
|
||||
|
||||
### -i, --include {#include}
|
||||
### -k, --insecure {#insecure}
|
||||
|
||||
Include the HTTP headers in the output (last entry).
|
||||
This option explicitly allows Hurl to perform "insecure" SSL connections and transfers.
|
||||
|
||||
### --interactive {#interactive}
|
||||
|
||||
@ -194,13 +197,10 @@ This is similar to a break point, You can then continue (Press C) or quit (Press
|
||||
|
||||
Output each hurl file result to JSON. The format is very closed to HAR format.
|
||||
|
||||
### -k, --insecure {#insecure}
|
||||
### --max-redirs <num> {#max-redirs}
|
||||
|
||||
This option explicitly allows Hurl to perform "insecure" SSL connections and transfers.
|
||||
|
||||
### -L, --location {#location}
|
||||
|
||||
Follow redirect. You can limit the amount of redirects to follow by using the [--max-redirs](#max-redirs) option.
|
||||
Set maximum number of redirection-followings allowed
|
||||
By default, the limit is set to 50 redirections. Set this option to -1 to make it unlimited.
|
||||
|
||||
### -m, --max-time <seconds> {#max-time}
|
||||
|
||||
@ -208,11 +208,6 @@ Maximum time in seconds that you allow a request/response to take. This is the s
|
||||
|
||||
See also [--connect-timeout](#connect-timeout) option.
|
||||
|
||||
### --max-redirs <num> {#max-redirs}
|
||||
|
||||
Set maximum number of redirection-followings allowed
|
||||
By default, the limit is set to 50 redirections. Set this option to -1 to make it unlimited.
|
||||
|
||||
### --no-color {#no-color}
|
||||
|
||||
Do not colorize Output
|
||||
@ -226,11 +221,6 @@ Suppress output. By default, Hurl outputs the body of the last response.
|
||||
Comma-separated list of hosts which do not use a proxy.
|
||||
Override value from Environment variable no_proxy.
|
||||
|
||||
### --to-entry <entry-number> {#to-entry}
|
||||
|
||||
Execute Hurl file to ENTRY_NUMBER (starting at 1).
|
||||
Ignore the remaining of the file. It is useful for debugging a session.
|
||||
|
||||
### -o, --output <file> {#output}
|
||||
|
||||
Write output to <file> instead of stdout.
|
||||
@ -239,6 +229,10 @@ Write output to <file> instead of stdout.
|
||||
|
||||
Print filename and status for each test (on stderr)
|
||||
|
||||
### -x, --proxy [protocol://]host[:port] {#proxy}
|
||||
|
||||
Use the specified proxy.
|
||||
|
||||
### --report-junit <file> {#report-junit}
|
||||
|
||||
Generate JUNIT <file>.
|
||||
@ -259,9 +253,10 @@ Print test metrics at the end of the run (on stderr)
|
||||
|
||||
Activate test mode; equals [--no-output](#no-output) [--progress](#progress) [--summary](#summary)
|
||||
|
||||
### -x, --proxy [protocol://]host[:port] {#proxy}
|
||||
### --to-entry <entry-number> {#to-entry}
|
||||
|
||||
Use the specified proxy.
|
||||
Execute Hurl file to ENTRY_NUMBER (starting at 1).
|
||||
Ignore the remaining of the file. It is useful for debugging a session.
|
||||
|
||||
### -u, --user <user:password> {#user}
|
||||
|
||||
@ -295,6 +290,10 @@ A line starting with '*' means additional info provided by Hurl.
|
||||
|
||||
If you only want HTTP headers in the output, -i, --include might be the option you're looking for.
|
||||
|
||||
### -h, --help {#help}
|
||||
|
||||
Usage help. This lists all current command line options with a short description.
|
||||
|
||||
### -V, --version {#version}
|
||||
|
||||
Prints version information
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
.TH hurl 1 "05 Feb 2022" "hurl 1.6.0-snapshot" " Hurl Manual"
|
||||
.TH hurl 1 "15 Feb 2022" "hurl 1.7.0-snapshot" " Hurl Manual"
|
||||
.SH NAME
|
||||
|
||||
hurl - run and test HTTP requests.
|
||||
@ -104,24 +104,17 @@ Thanks to asserts, Hurl can be used as a testing tool to run scenarii.
|
||||
|
||||
Options that exist in curl have exactly the same semantic.
|
||||
|
||||
.IP "--cacert "
|
||||
|
||||
Tells curl to use the specified certificate file to verify the peer.
|
||||
The file may contain multiple CA certificates.
|
||||
The certificate(s) must be in PEM format.
|
||||
Normally curl is built to use a default file for this, so this option is typically used to alter that default file.
|
||||
|
||||
.IP "--color "
|
||||
|
||||
Colorize Output
|
||||
|
||||
.IP "-b, --cookie <file> "
|
||||
|
||||
Read cookies from file (using the Netscape cookie file format).
|
||||
|
||||
Combined with \fI-c, --cookie-jar\fP, you can simulate a cookie storage between successive Hurl runs.
|
||||
|
||||
.IP "--cacert "
|
||||
|
||||
Tells curl to use the specified certificate file to verify the peer.
|
||||
The file may contain multiple CA certificates.
|
||||
The certificate(s) must be in PEM format.
|
||||
Normally curl is built to use a default file for this, so this option is typically used to alter that default file.
|
||||
|
||||
.IP "--compressed "
|
||||
|
||||
Request a compressed response using one of the algorithms br, gzip, deflate and automatically decompress the content.
|
||||
@ -132,6 +125,12 @@ Maximum time in seconds that you allow Hurl's connection to take.
|
||||
|
||||
See also \fI-m, --max-time\fP option.
|
||||
|
||||
.IP "-b, --cookie <file> "
|
||||
|
||||
Read cookies from file (using the Netscape cookie file format).
|
||||
|
||||
Combined with \fI-c, --cookie-jar\fP, you can simulate a cookie storage between successive Hurl runs.
|
||||
|
||||
.IP "-c, --cookie-jar <file> "
|
||||
|
||||
Write cookies to FILE after running the session (only for one session).
|
||||
@ -153,6 +152,10 @@ All the input files are executed independently. The result of one file does not
|
||||
Set root filesystem to import files in Hurl. This is used for both files in multipart form data and request body.
|
||||
When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.
|
||||
|
||||
.IP "-L, --location "
|
||||
|
||||
Follow redirect. You can limit the amount of redirects to follow by using the \fI--max-redirs\fP option.
|
||||
|
||||
.IP "--glob <glob> "
|
||||
|
||||
Specify input files that match the given blob.
|
||||
@ -160,17 +163,17 @@ Specify input files that match the given blob.
|
||||
Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and [].
|
||||
However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.
|
||||
|
||||
.IP "-h, --help "
|
||||
.IP "-i, --include "
|
||||
|
||||
Usage help. This lists all current command line options with a short description.
|
||||
Include the HTTP headers in the output (last entry).
|
||||
|
||||
.IP "--ignore-asserts "
|
||||
|
||||
Ignore all asserts defined in the Hurl file.
|
||||
|
||||
.IP "-i, --include "
|
||||
.IP "-k, --insecure "
|
||||
|
||||
Include the HTTP headers in the output (last entry).
|
||||
This option explicitly allows Hurl to perform "insecure" SSL connections and transfers.
|
||||
|
||||
.IP "--interactive "
|
||||
|
||||
@ -181,13 +184,10 @@ This is similar to a break point, You can then continue (Press C) or quit (Press
|
||||
|
||||
Output each hurl file result to JSON. The format is very closed to HAR format.
|
||||
|
||||
.IP "-k, --insecure "
|
||||
.IP "--max-redirs <num> "
|
||||
|
||||
This option explicitly allows Hurl to perform "insecure" SSL connections and transfers.
|
||||
|
||||
.IP "-L, --location "
|
||||
|
||||
Follow redirect. You can limit the amount of redirects to follow by using the \fI--max-redirs\fP option.
|
||||
Set maximum number of redirection-followings allowed
|
||||
By default, the limit is set to 50 redirections. Set this option to -1 to make it unlimited.
|
||||
|
||||
.IP "-m, --max-time <seconds> "
|
||||
|
||||
@ -195,11 +195,6 @@ Maximum time in seconds that you allow a request/response to take. This is the s
|
||||
|
||||
See also \fI--connect-timeout\fP option.
|
||||
|
||||
.IP "--max-redirs <num> "
|
||||
|
||||
Set maximum number of redirection-followings allowed
|
||||
By default, the limit is set to 50 redirections. Set this option to -1 to make it unlimited.
|
||||
|
||||
.IP "--no-color "
|
||||
|
||||
Do not colorize Output
|
||||
@ -213,11 +208,6 @@ Suppress output. By default, Hurl outputs the body of the last response.
|
||||
Comma-separated list of hosts which do not use a proxy.
|
||||
Override value from Environment variable no_proxy.
|
||||
|
||||
.IP "--to-entry <entry-number> "
|
||||
|
||||
Execute Hurl file to ENTRY_NUMBER (starting at 1).
|
||||
Ignore the remaining of the file. It is useful for debugging a session.
|
||||
|
||||
.IP "-o, --output <file> "
|
||||
|
||||
Write output to <file> instead of stdout.
|
||||
@ -226,6 +216,10 @@ Write output to <file> instead of stdout.
|
||||
|
||||
Print filename and status for each test (on stderr)
|
||||
|
||||
.IP "-x, --proxy [protocol://]host[:port] "
|
||||
|
||||
Use the specified proxy.
|
||||
|
||||
.IP "--report-junit <file> "
|
||||
|
||||
Generate JUNIT <file>.
|
||||
@ -246,14 +240,19 @@ Print test metrics at the end of the run (on stderr)
|
||||
|
||||
Activate test mode; equals \fI--no-output](#no-output) [--progress](#progress) [--summary\fP
|
||||
|
||||
.IP "-x, --proxy [protocol://]host[:port] "
|
||||
.IP "--to-entry <entry-number> "
|
||||
|
||||
Use the specified proxy.
|
||||
Execute Hurl file to ENTRY_NUMBER (starting at 1).
|
||||
Ignore the remaining of the file. It is useful for debugging a session.
|
||||
|
||||
.IP "-u, --user <user:password> "
|
||||
|
||||
Add basic Authentication header to each request.
|
||||
|
||||
.IP "-A, --user-agent <name> "
|
||||
|
||||
Specify the User-Agent string to send to the HTTP server.
|
||||
|
||||
.IP "--variable <name=value> "
|
||||
|
||||
Define variable (name/value) to be used in Hurl templates.
|
||||
@ -278,6 +277,10 @@ A line starting with '*' means additional info provided by Hurl.
|
||||
|
||||
If you only want HTTP headers in the output, -i, --include might be the option you're looking for.
|
||||
|
||||
.IP "-h, --help "
|
||||
|
||||
Usage help. This lists all current command line options with a short description.
|
||||
|
||||
.IP "-V, --version "
|
||||
|
||||
Prints version information
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
.TH hurl 1 "05 Feb 2022" "hurl 1.6.0-snapshot" " Hurl Manual"
|
||||
.TH hurl 1 "15 Feb 2022" "hurl 1.7.0-snapshot" " Hurl Manual"
|
||||
.SH NAME
|
||||
|
||||
hurlfmt - format Hurl files
|
||||
|
||||
@ -174,11 +174,11 @@ pub fn app(version: &str) -> App {
|
||||
.help("Output each hurl file result to JSON"),
|
||||
)
|
||||
.arg(
|
||||
clap::Arg::new("junit")
|
||||
.long("report-junit")
|
||||
.value_name("FILE")
|
||||
.help("Write a Junit XML report to the given file")
|
||||
.takes_value(true),
|
||||
clap::Arg::new("max_redirects")
|
||||
.long("max-redirs")
|
||||
.value_name("NUM")
|
||||
.allow_hyphen_values(true)
|
||||
.help("Maximum number of redirects allowed"),
|
||||
)
|
||||
.arg(
|
||||
clap::Arg::new("max_time")
|
||||
@ -188,13 +188,6 @@ pub fn app(version: &str) -> App {
|
||||
.allow_hyphen_values(true)
|
||||
.help("Maximum time allowed for the transfer"),
|
||||
)
|
||||
.arg(
|
||||
clap::Arg::new("max_redirects")
|
||||
.long("max-redirs")
|
||||
.value_name("NUM")
|
||||
.allow_hyphen_values(true)
|
||||
.help("Maximum number of redirects allowed"),
|
||||
)
|
||||
.arg(
|
||||
clap::Arg::new("no_color")
|
||||
.long("no-color")
|
||||
@ -233,6 +226,13 @@ pub fn app(version: &str) -> App {
|
||||
.value_name("[PROTOCOL://]HOST[:PORT]")
|
||||
.help("Use proxy on given protocol/host/port"),
|
||||
)
|
||||
.arg(
|
||||
clap::Arg::new("junit")
|
||||
.long("report-junit")
|
||||
.value_name("FILE")
|
||||
.help("Write a Junit XML report to the given file")
|
||||
.takes_value(true),
|
||||
)
|
||||
.arg(
|
||||
clap::Arg::new("report_html")
|
||||
.long("report-html")
|
||||
|
||||
Loading…
Reference in New Issue
Block a user