Tribblix: manual page: hurl.1

hurl(1) Hurl Manual hurl(1)

NAME

hurl - run and test HTTP requests.

SYNOPSIS

hurl [options] [FILE...]

DESCRIPTION

Hurl is an HTTP client that performs HTTP requests defined in a
simple plain text format.

Hurl is very versatile. It enables chaining HTTP requests, capturing
values from HTTP responses, and making assertions.

$ hurl session.hurl

If no input files are specified, input is read from stdin.

$ echo GET http://httpbin.org/get | hurl
{
"args": {},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "gzip",
"Content-Length": "0",
"Host": "httpbin.org",
"User-Agent": "hurl/0.99.10",
"X-Amzn-Trace-Id":
"Root=1-5eedf4c7-520814d64e2f9249ea44e0"
},
"origin": "1.2.3.4",
"url": "http://httpbin.org/get"
}

Output goes to stdout by default. To have output go to a file, use
the -o, --output option:

$ hurl -o output input.hurl

By default, Hurl executes all HTTP requests and outputs the response
body of the last HTTP call.

To have a test oriented output, you can use --test option:

$ hurl --test *.hurl

HURL FILE FORMAT

The Hurl file format is fully documented in
https://hurl.dev/docs/hurl-file.html

It consists of one or several HTTP requests

GET http:/example.org/endpoint1
GET http:/example.org/endpoint2

Capturing values

A value from an HTTP response can be-reused for successive
HTTP requests.

A typical example occurs with csrf tokens.

GET https://example.org
HTTP/1.1 200
# Capture the CSRF token value from html body.
[Captures]
csrf_token: xpath "normalize-
space(//meta[@name='_csrf_token']/@content)"

# Do the login !
POST https://example.org/login?user=toto&password=1234
X-CSRF-TOKEN: {{csrf_token}}

More information on captures can be found here
https://hurl.dev/docs/capturing-response.html

Asserts

The HTTP response defined in the Hurl session are used to make
asserts.

At the minimum, the response includes the asserts on the HTTP
version and status code.

GET http:/google.com
HTTP/1.1 301

It can also include asserts on the response headers

GET http:/google.com
HTTP/1.1 301
Location: http://www.google.com

Explicit asserts can be included by combining a query and a
predicate

GET http:/google.com
HTTP/1.1 301
[Asserts]
xpath "string(//title)" == "301 Moved"

With the addition of asserts, Hurl can be used as a testing
tool to run scenarios.

More information on asserts can be found here
https://hurl.dev/docs/asserting-response.html

OPTIONS

Options that exist in curl have exactly the same semantics.

Options specified on the command line are defined for every Hurl
file's entry.

For instance:

$ hurl --location foo.hurl

will follow redirection for each entry in `foo.hurl`. You can also
define an option only for a particular entry with an `[Options]`
section. For instance, this Hurl file:

GET https://google.com
HTTP/* 301

GET https://google.com
[Options]
location: true
HTTP/* 200

will follow a redirection only for the second entry.

--cacert

Specifies the certificate file for peer verification. The file
may contain multiple CA certificates and must be in PEM
format. Normally Hurl is built to use a default file for
this, so this option is typically used to alter that default
file.

--color

Colorize Output.

--compressed

Request a compressed response using one of the algorithms br,
gzip, deflate and automatically decompress the content.

--connect-timeout <SECONDS>

Maximum time in seconds that you allow Hurl's connection to
take.

See also -m, --max-time option.

-b, --cookie <FILE>

Read cookies from FILE (using the Netscape cookie file
format).

Combined with -c, --cookie-jar, you can simulate a cookie
storage between successive Hurl runs.

-c, --cookie-jar <FILE>

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, you can simulate a cookie storage
between successive Hurl runs.

--fail-at-end

Continue executing requests to the end of the Hurl file even
when an assert error occurs. By default, Hurl exits after an
assert error in the HTTP response.

Note that this option does not affect the behavior with
multiple input Hurl files.

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>

Set root file system 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

Follow redirect. To limit the amount of redirects to follow
use the --max-redirs option

--glob <GLOB>

Specify input files that match the given glob pattern.

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.

-i, --include

Include the HTTP headers in the output (last entry).

--ignore-asserts

Ignore all asserts defined in the Hurl file.

-k, --insecure

This option explicitly allows Hurl to perform "insecure" SSL
connections and transfers.

--interactive

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

--json

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

--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.

-m, --max-time <SECONDS>

Maximum time in seconds that you allow a request/response to
take. This is the standard timeout.

See also --connect-timeout option.

--no-color

Do not colorize output.

--no-output

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

--noproxy <HOST(S)>

Comma-separated list of hosts which do not use a proxy.
Override value from Environment variable no_proxy.

-o, --output <FILE>

Write output to FILE instead of stdout.

-x, --proxy [protocol://]host[:port]

Use the specified proxy.

--report-junit <FILE>

Generate JUnit File.

If the FILE report already exists, it will be updated with the
new test results.

--report-html <DIR>

Generate HTML report in DIR.

If the HTML report already exists, it will be updated with the
new test results.

--retry

Retry requests if any error occurs (asserts, captures,
runtimes etc...).

--retry-interval <MILLISECONDS>

Duration in milliseconds between each retry. Default is 1000
ms.

--retry-max-count <NUM>

Maximum number of retries. Set this option to -1 to make it
unlimited. Default is 10.

--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.

--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.

-u, --user <USER:PASSWORD>

Add basic Authentication header to each request.

-A, --user-agent <NAME>

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

--variable <NAME=VALUE>

Define variable (name/value) to be used in Hurl templates.

--variables-file <FILE>

Set properties file in which your define your variables.

Each variable is defined as name=value exactly as with
--variable option.

Note that defining a variable twice produces an error.

-v, --verbose

Turn on verbose output on standard error stream. Useful for
debugging.

A line starting with '>' means data sent by Hurl. A line
staring with '<' means data received by Hurl. 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.

--very-verbose

Turn on more verbose output on standard error stream.

In contrast to --verbose option, this option outputs the full
HTTP body request and response on standard error. In addition,
lines starting with '**' are libcurl debug logs.

-h, --help

Usage help. This lists all current command line options with a
short description.

-V, --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 option.

http_proxy [protocol://]<host>[:port]

Sets the proxy server to use for HTTP.

https_proxy [protocol://]<host>[:port]

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.

no_proxy <comma-separated list of hosts>

List of host names that shouldn't go through any proxy.

HURL_name value

Define variable (name/value) to be used in Hurl templates.
This is similar than --variable and --variables-file options.

NO_COLOR

When set to a non-empty string, do not colorize output (see
--no-color option).

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