mirror of
https://github.com/Orange-OpenSource/hurl.git
synced 2024-12-25 03:52:09 +03:00
Uniform options line break (for better processing in hurl.dev).
This commit is contained in:
jcamiel
jcamiel
parent
5220b55a69
commit
c89da9a1bb
58
docs/hurl.md
58
docs/hurl.md
@ -122,44 +122,35 @@ Options that exist in curl have exactly the same semantic.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
### --connect-timeout <seconds> {#connect-timeout}
|
||||
|
||||
Maximum time in seconds that you allow Hurl's connection to take.
|
||||
|
||||
See also [-m, --max-time](#max-time) option.
|
||||
|
||||
|
||||
### -c, --cookie-jar <file> {#cookie-jar}
|
||||
|
||||
Write cookies to FILE after running the session (only for one session).
|
||||
The file will be written using the Netscape cookie file format.
|
||||
|
||||
Combined with [-b, --cookie](#cookie),you can simulate a cookie storage between successive Hurl runs.
|
||||
|
||||
|
||||
Combined with [-b, --cookie](#cookie), you can simulate a cookie storage between successive Hurl runs.
|
||||
|
||||
### --fail-at-end {#fail-at-end}
|
||||
|
||||
@ -170,105 +161,81 @@ Note that this option does not affect the behavior with multiple input Hurl file
|
||||
|
||||
All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.
|
||||
|
||||
|
||||
### --file-root <dir> {#file-root}
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
### -h, --help {#help}
|
||||
|
||||
Usage help. This lists all current command line options with a short description.
|
||||
|
||||
|
||||
|
||||
### --html <dir> {#html}
|
||||
|
||||
Generate html report in dir.
|
||||
|
||||
If the html report already exists, it will be updated with the new test results.
|
||||
|
||||
|
||||
### --ignore-asserts {#ignore-asserts}
|
||||
|
||||
Ignore all asserts defined in the Hurl file.
|
||||
|
||||
|
||||
### -i, --include {#include}
|
||||
|
||||
Include the HTTP headers in the output (last entry).
|
||||
|
||||
|
||||
### --interactive {#interactive}
|
||||
|
||||
Stop between requests.
|
||||
This is similar to a break point, You can then continue (Press C) or quit (Press Q).
|
||||
|
||||
|
||||
### --json <file> {#json}
|
||||
|
||||
Write full session(s) to a json file. The format is very closed to HAR format.
|
||||
|
||||
If the json file already exists, the file will be updated with the new test results.
|
||||
|
||||
|
||||
### -k, --insecure {#insecure}
|
||||
|
||||
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.
|
||||
|
||||
|
||||
### -m, --max-time <seconds> {#max-time}
|
||||
|
||||
Maximum time in seconds that you allow a request/response to take. This is the standard timeout.
|
||||
|
||||
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 {#color}
|
||||
|
||||
Do not colorize Output
|
||||
|
||||
|
||||
|
||||
### --noproxy <no-proxy-list> {#noproxy}
|
||||
|
||||
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.
|
||||
|
||||
|
||||
### --progress {#progress}
|
||||
|
||||
Print filename and status for each test
|
||||
|
||||
|
||||
### --summary {#summary}
|
||||
|
||||
Print test metrics at the end of the run
|
||||
@ -277,7 +244,6 @@ Print test metrics at the end of the run
|
||||
|
||||
Activate test mode; equals --output /dev/null --progress --summary
|
||||
|
||||
|
||||
### -x, --proxy [protocol://]host[:port] {#proxy}
|
||||
|
||||
Use the specified proxy.
|
||||
@ -286,13 +252,11 @@ Use the specified proxy.
|
||||
|
||||
Add basic Authentication header to each request.
|
||||
|
||||
|
||||
### --variable <name=value> {#variable}
|
||||
|
||||
Define variable (name/value) to be used in Hurl templates.
|
||||
Only string values can be defined.
|
||||
|
||||
|
||||
### --variables-file <file> {#variables-file}
|
||||
|
||||
Set properties file in which your define your variables.
|
||||
@ -301,7 +265,6 @@ Each variable is defined as name=value exactly as with [--variable](#variable) o
|
||||
|
||||
Note that defining a variable twice produces an error.
|
||||
|
||||
|
||||
### -v, --verbose {#verbose}
|
||||
|
||||
Turn on verbose output on standard error stream
|
||||
@ -313,19 +276,15 @@ 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.
|
||||
|
||||
|
||||
### -V, --version {#version}
|
||||
|
||||
Prints version information
|
||||
|
||||
|
||||
|
||||
## ENVIRONMENT
|
||||
|
||||
Environment variables can only be specified in lowercase.
|
||||
|
||||
Using an environment variable to set the proxy has the same effect as using
|
||||
the [-x, --proxy](#proxy) option.
|
||||
Using an environment variable to set the proxy has the same effect as using the [-x, --proxy](#proxy) option.
|
||||
|
||||
### http_proxy [protocol://]<host>[:port]
|
||||
|
||||
@ -336,7 +295,6 @@ Sets the proxy server to use for HTTP.
|
||||
|
||||
Sets the proxy server to use for HTTPS.
|
||||
|
||||
|
||||
### all_proxy [protocol://]<host>[:port]
|
||||
|
||||
Sets the proxy server to use if no protocol-specific proxy is set.
|
||||
@ -345,26 +303,24 @@ Sets the proxy server to use if no protocol-specific proxy is set.
|
||||
|
||||
list of host names that shouldn't go through any proxy.
|
||||
|
||||
|
||||
## EXIT CODES
|
||||
|
||||
### 1
|
||||
|
||||
Failed to parse command-line options.
|
||||
|
||||
|
||||
### 2
|
||||
|
||||
Input File Parsing Error.
|
||||
|
||||
|
||||
### 3
|
||||
|
||||
Runtime error (such as failure to connect to host).
|
||||
|
||||
|
||||
### 4
|
||||
|
||||
Assert Error.
|
||||
|
||||
|
||||
|
||||
## WWW
|
||||
|
||||
[https://hurl.dev](https://hurl.dev)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user