diff --git a/docs/manual/hurl.md b/docs/manual/hurl.md index b3bb4e1cd..b6122cc6c 100644 --- a/docs/manual/hurl.md +++ b/docs/manual/hurl.md @@ -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. @@ -200,6 +202,8 @@ 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 {#cookie-jar} Write cookies to FILE after running the session (only for one session). @@ -207,6 +211,8 @@ 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 {#delay} Sets delay before each request. @@ -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 {#file-root} Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output. @@ -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. @@ -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. @@ -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} Private key file name. @@ -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. @@ -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 {#noproxy} Comma-separated list of hosts which do not use a proxy. @@ -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. @@ -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 {#user-agent} Specify the User-Agent string to send to the HTTP server. +This is a cli-only option. + ### --variable {#variable} Define variable (name/value) to be used in Hurl templates. @@ -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. diff --git a/docs/spec/options/hurl/color.option b/docs/spec/options/hurl/color.option index a8039894d..c9b675334 100644 --- a/docs/spec/options/hurl/color.option +++ b/docs/spec/options/hurl/color.option @@ -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). diff --git a/docs/spec/options/hurl/cookies_input_file.option b/docs/spec/options/hurl/cookies_input_file.option index 19fe336d5..5807e2967 100644 --- a/docs/spec/options/hurl/cookies_input_file.option +++ b/docs/spec/options/hurl/cookies_input_file.option @@ -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). diff --git a/docs/spec/options/hurl/cookies_output_file.option b/docs/spec/options/hurl/cookies_output_file.option index 552c686a6..895a77876 100644 --- a/docs/spec/options/hurl/cookies_output_file.option +++ b/docs/spec/options/hurl/cookies_output_file.option @@ -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. diff --git a/docs/spec/options/hurl/error_format.option b/docs/spec/options/hurl/error_format.option index ae63e434a..7fcdb42a7 100644 --- a/docs/spec/options/hurl/error_format.option +++ b/docs/spec/options/hurl/error_format.option @@ -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) diff --git a/docs/spec/options/hurl/ignore_asserts.option b/docs/spec/options/hurl/ignore_asserts.option index de82c3392..9943b9e12 100644 --- a/docs/spec/options/hurl/ignore_asserts.option +++ b/docs/spec/options/hurl/ignore_asserts.option @@ -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. diff --git a/docs/spec/options/hurl/include.option b/docs/spec/options/hurl/include.option index 6af241499..64a06e1dd 100644 --- a/docs/spec/options/hurl/include.option +++ b/docs/spec/options/hurl/include.option @@ -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 diff --git a/docs/spec/options/hurl/interactive.option b/docs/spec/options/hurl/interactive.option index 9cc6ac6fd..0f2c54a17 100644 --- a/docs/spec/options/hurl/interactive.option +++ b/docs/spec/options/hurl/interactive.option @@ -2,6 +2,7 @@ name: interactive long: interactive help: Turn on interactive mode conflict: to_entry +cli_only: true --- Stop between requests. diff --git a/docs/spec/options/hurl/json.option b/docs/spec/options/hurl/json.option index 9de54cd90..bd18e08b2 100644 --- a/docs/spec/options/hurl/json.option +++ b/docs/spec/options/hurl/json.option @@ -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. diff --git a/docs/spec/options/hurl/max_time.option b/docs/spec/options/hurl/max_time.option index daf7794ef..45a6ff13e 100644 --- a/docs/spec/options/hurl/max_time.option +++ b/docs/spec/options/hurl/max_time.option @@ -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. diff --git a/docs/spec/options/hurl/no_color.option b/docs/spec/options/hurl/no_color.option index 6608c8942..1d6d24a49 100644 --- a/docs/spec/options/hurl/no_color.option +++ b/docs/spec/options/hurl/no_color.option @@ -2,5 +2,6 @@ name: no_color long: no-color help: Do not colorize output conflict: color +cli_only: true --- Do not colorize output. diff --git a/docs/spec/options/hurl/no_output.option b/docs/spec/options/hurl/no_output.option index 63f7b3a46..7b274a596 100644 --- a/docs/spec/options/hurl/no_output.option +++ b/docs/spec/options/hurl/no_output.option @@ -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. diff --git a/docs/spec/options/hurl/ssl_no_revoke.option b/docs/spec/options/hurl/ssl_no_revoke.option index 5696fb457..a991de8df 100644 --- a/docs/spec/options/hurl/ssl_no_revoke.option +++ b/docs/spec/options/hurl/ssl_no_revoke.option @@ -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. diff --git a/docs/spec/options/hurl/user.option b/docs/spec/options/hurl/user.option index 9eb87ea9c..c76077e20 100644 --- a/docs/spec/options/hurl/user.option +++ b/docs/spec/options/hurl/user.option @@ -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. diff --git a/docs/spec/options/hurl/user_agent.option b/docs/spec/options/hurl/user_agent.option index 8787c408b..0beda8c8e 100644 --- a/docs/spec/options/hurl/user_agent.option +++ b/docs/spec/options/hurl/user_agent.option @@ -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. diff --git a/docs/spec/options/hurl/variables_file.option b/docs/spec/options/hurl/variables_file.option index 9627c54da..16d3aeff9 100644 --- a/docs/spec/options/hurl/variables_file.option +++ b/docs/spec/options/hurl/variables_file.option @@ -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.