Skip to content

Commit

Permalink
Tag options not available yet in the Hurl file as cli-only
Browse files Browse the repository at this point in the history
  • Loading branch information
fabricereix committed Feb 29, 2024
1 parent 6b92746 commit accc2fc
Show file tree
Hide file tree
Showing 16 changed files with 45 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/manual/hurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ See also [`--key`](#key).

Colorize debug output (the HTTP response output is not colorized).

This is a cli-only option.

### --compressed {#compressed}

Request a compressed response using one of the algorithms br, gzip, deflate and automatically decompress the content.
Expand Down Expand Up @@ -200,13 +202,17 @@ 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.

This is a cli-only 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.

This is a cli-only option.

### --delay <MILLISECONDS> {#delay}

Sets delay before each request.
Expand All @@ -215,6 +221,8 @@ Sets delay before each request.

Control the format of error message (short by default or long)

This is a cli-only option.

### --file-root <DIR> {#file-root}

Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
Expand Down Expand Up @@ -253,10 +261,14 @@ Tells Hurl to try HTTP/3 to the host in the URL, but fallback to earlier HTTP ve

Ignore all asserts defined in the Hurl file.

This is a cli-only option.

### -i, --include {#include}

Include the HTTP headers in the output

This is a cli-only option.

### -k, --insecure {#insecure}

This option explicitly allows Hurl to perform "insecure" SSL connections and transfers.
Expand All @@ -267,6 +279,8 @@ Stop between requests.

This is similar to a break point, You can then continue (Press C) or quit (Press Q).

This is a cli-only option.

### -4, --ipv4 {#ipv4}

This option tells Hurl to use IPv4 addresses only when resolving host names, and not for example try IPv6.
Expand All @@ -279,6 +293,8 @@ This option tells Hurl to use IPv6 addresses only when resolving host names, and

Output each Hurl file result to JSON. The format is very closed to HAR format.

This is a cli-only option.

### --key <KEY> {#key}

Private key file name.
Expand All @@ -304,6 +320,8 @@ Maximum time in seconds that you allow a request/response to take. This is the s

See also [`--connect-timeout`](#connect-timeout).

This is a cli-only option.

### -n, --netrc {#netrc}

Scan the .netrc file in the user's home directory for the username and password.
Expand All @@ -326,10 +344,14 @@ See also [`--netrc-file`](#netrc-file).

Do not colorize output.

This is a cli-only option.

### --no-output {#no-output}

Suppress output. By default, Hurl outputs the body of the last response.

This is a cli-only option.

### --noproxy <HOST(S)> {#noproxy}

Comma-separated list of hosts which do not use a proxy.
Expand Down Expand Up @@ -388,6 +410,8 @@ Duration in milliseconds between each retry. Default is 1000 ms.

(Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.

This is a cli-only option.

### --test {#test}

Activate test mode: with this, the HTTP response is not outputted anymore, progress is reported for each Hurl file tested, and a text summary is displayed when all files have been run.
Expand All @@ -409,10 +433,14 @@ This is a cli-only option.

Add basic Authentication header to each request.

This is a cli-only option.

### -A, --user-agent <NAME> {#user-agent}

Specify the User-Agent string to send to the HTTP server.

This is a cli-only option.

### --variable <NAME=VALUE> {#variable}

Define variable (name/value) to be used in Hurl templates.
Expand All @@ -425,6 +453,8 @@ Each variable is defined as name=value exactly as with [`--variable`](#variable)

Note that defining a variable twice produces an error.

This is a cli-only option.

### -v, --verbose {#verbose}

Turn on verbose output on standard error stream.
Expand Down
1 change: 1 addition & 0 deletions docs/spec/options/hurl/color.option
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ name: color
long: color
help: Colorize output
conflict: no_color
cli_only: true
---
Colorize debug output (the HTTP response output is not colorized).
1 change: 1 addition & 0 deletions docs/spec/options/hurl/cookies_input_file.option
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ long: cookie
short: b
value: FILE
help: Read cookies from FILE
cli_only: true
---
Read cookies from FILE (using the Netscape cookie file format).

Expand Down
1 change: 1 addition & 0 deletions docs/spec/options/hurl/cookies_output_file.option
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ long: cookie-jar
short: c
value: FILE
help: Write cookies to FILE after running the session (only for one session)
cli_only: true
---
Write cookies to FILE after running the session (only for one session).
The file will be written using the Netscape cookie file format.
Expand Down
1 change: 1 addition & 0 deletions docs/spec/options/hurl/error_format.option
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ value: FORMAT
value_default: short
value_parser: ["short", "long"]
help: Control the format of error messages
cli_only: true
---
Control the format of error message (short by default or long)
1 change: 1 addition & 0 deletions docs/spec/options/hurl/ignore_asserts.option
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: ignore_asserts
long: ignore-asserts
help: Ignore asserts defined in the Hurl file
cli_only: true
---
Ignore all asserts defined in the Hurl file.
1 change: 1 addition & 0 deletions docs/spec/options/hurl/include.option
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ name: include
long: include
short: i
help: Include the HTTP headers in the output
cli_only: true
---
Include the HTTP headers in the output
1 change: 1 addition & 0 deletions docs/spec/options/hurl/interactive.option
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: interactive
long: interactive
help: Turn on interactive mode
conflict: to_entry
cli_only: true
---
Stop between requests.

Expand Down
1 change: 1 addition & 0 deletions docs/spec/options/hurl/json.option
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ name: json
long: json
help: Output each Hurl file result to JSON
conflict: no_output
cli_only: true
---
Output each Hurl file result to JSON. The format is very closed to HAR format.
1 change: 1 addition & 0 deletions docs/spec/options/hurl/max_time.option
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ value: SECONDS
value_default: 300
value_parser: clap::value_parser!(u64)
help: Maximum time allowed for the transfer
cli_only: true
---
Maximum time in seconds that you allow a request/response to take. This is the standard timeout.

Expand Down
1 change: 1 addition & 0 deletions docs/spec/options/hurl/no_color.option
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ name: no_color
long: no-color
help: Do not colorize output
conflict: color
cli_only: true
---
Do not colorize output.
1 change: 1 addition & 0 deletions docs/spec/options/hurl/no_output.option
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ name: no_output
long: no-output
help: Suppress output. By default, Hurl outputs the body of the last response
conflict: json
cli_only: true
---
Suppress output. By default, Hurl outputs the body of the last response.
1 change: 1 addition & 0 deletions docs/spec/options/hurl/ssl_no_revoke.option
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: ssl_no_revoke
long: ssl-no-revoke
help: (Windows) Tell Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.
cli_only: true
---
(Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.
1 change: 1 addition & 0 deletions docs/spec/options/hurl/user.option
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ long: user
short: u
value: USER:PASSWORD
help: Add basic Authentication header to each request
cli_only: true
---
Add basic Authentication header to each request.
1 change: 1 addition & 0 deletions docs/spec/options/hurl/user_agent.option
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ long: user-agent
short: A
value: NAME
help: Specify the User-Agent string to send to the HTTP server
cli_only: true
---
Specify the User-Agent string to send to the HTTP server.
1 change: 1 addition & 0 deletions docs/spec/options/hurl/variables_file.option
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ long: variables-file
value: FILE
help: Define a properties file in which you define your variables
multi: append
cli_only: true
---
Set properties file in which your define your variables.

Expand Down

0 comments on commit accc2fc

Please sign in to comment.