hurl/docs/hurl.1

.TH hurl 1 "DATE" "hurl 0.99.13" " Hurl Manual"
.SH NAME

hurl - run and test HTTP requests.


.SH SYNOPSIS

.B hurl
[options] [FILE...]


.SH DESCRIPTION

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

Hurl is very versatile, it enables to chain HTTP requests, capture values from HTTP responses and make asserts.

    $ 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-520814d64e2f9249ea44e0f0"
          },
          "origin": "1.2.3.4",
          "url": "http://httpbin.org/get"
        }


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

    $ hurl -o output input.hurl



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



.SH HURL FILE FORMAT

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

It consists of one or several HTTP requests

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


.IP "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.net
    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.net/login?user=toto&password=1234
    X-CSRF-TOKEN: {{csrf_token}}

.IP "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 302

It can also include asserts on the response headers

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

You can also include explicit asserts combining query and predicate

    GET http:/google.com
    HTTP/1.1 302
    [Asserts]
    xpath "//title" equals "301 Moved"

Thanks to asserts, Hurl can be used as a testing tool to run scenarii.




.SH OPTIONS

Options that exist in curl have exactly the same semantic.


.IP "--append "

This option can only be used with \fI--json\fP. It appends sessions to existing file instead of overwriting it.
This is typically used in a CI pipeline.


.IP "--color "

Colorize Output



.IP "-b, --cookie <filename> "

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 "--compressed"

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


.IP "--connect-timeout <seconds> "

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

See also \fI-m, --max-time\fP option.


.IP "-c, --cookie-jar <filename> "

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



.IP "--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 mutiple input Hurl files.

All the input files are executed independently. The result of one file does not affect the excecution of the other Hurl files.


.IP "--file-root <dir> "

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 "-h, --help "

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



.IP "--html <dir> "

Generate html report in dir.

If you want to combine results from different Hurl executions in a unique html report, you must also use the options \fI--json](#json) and [--append\fP.



.IP "-i, --include "

Include the HTTP headers in the output.



.IP "--json <file> "

Write full session(s) to a json file. The format is very closed to HAR format.

By default, this file is overwritten by the current run execution.
In order to append sessions to an existing json file, the option \fI--append\fP must be used.
This is typically used in a CI pipeline.



.IP "-k, --insecure "

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.


.IP "-m, --max-time <seconds> "

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

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



.IP "--noproxy <no-proxy-list> "

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.



.IP "-x, --proxy [protocol://]host[:port] "

Use the specified proxy.

.IP "-u, --user <user:password> "

Add basic Authentication header to each request.


.IP "--variable <name=value> "

Define variable (name/value) to be used in Hurl templates.
Only string values can be defined.



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


.IP "-V, --version "

Prints version information



.SH ENVIRONMENT

Environment variables can only be specified in lowercase.

Using an environment variable to set the proxy has the same effect as using
the \fI-x, --proxy\fP option.

.IP "http_proxy [protocol://]<host>[:port]"

Sets the proxy server to use for HTTP.


.IP "https_proxy [protocol://]<host>[:port]"

Sets the proxy server to use for HTTPS.


.IP "all_proxy [protocol://]<host>[:port]"

Sets the proxy server to use if no protocol-specific proxy is set.

.IP "no_proxy <comma-separated list of hosts>"

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


.SH EXIT CODES

.IP "1"
Failed to parse command-line options.


.IP "2"
Input File Parsing Error.


.IP "3"
Runtime error (such as failure to connect to host).


.IP "4"
Assert Error.



.SH WWW

\fIhttps://hurl.dev\fP


.SH SEE ALSO

curl(1)  hurlfmt(1)