[](https://github.com/Orange-OpenSource/hurl/actions)
[](https://Orange-OpenSource.github.io/hurl/coverage)
[](https://crates.io/crates/hurl)
[](https://hurl.dev)
# What's Hurl?
Hurl is a command line tool that runs HTTP requests defined in a simple plain text format.
It can chain requests, capture values and evaluate queries on headers and body response. Hurl is very
versatile: it can be used for both fetching data and testing HTTP sessions.
Hurl makes it easy to work with HTML content, REST / SOAP / GraphQL APIs, or any other XML / JSON based APIs.
```hurl
# Get home:
GET https://example.org
HTTP 200
[Captures]
csrf_token: xpath "string(//meta[@name='_csrf_token']/@content)"
# Do login!
POST https://example.org/login?user=toto&password=1234
X-CSRF-TOKEN: {{csrf_token}}
HTTP 302
```
Chaining multiple requests is easy:
```hurl
GET https://example.org/api/health
GET https://example.org/api/step1
GET https://example.org/api/step2
GET https://example.org/api/step3
```
# Also an HTTP Test Tool
Hurl can run HTTP requests but can also be used to test HTTP responses.
Different types of queries and predicates are supported, from [XPath] and [JSONPath] on body response,
to assert on status code and response headers.
It is well adapted for REST / JSON APIs
```hurl
POST https://example.org/api/tests
{
"id": "4568",
"evaluate": true
}
HTTP 200
[Asserts]
header "X-Frame-Options" == "SAMEORIGIN"
jsonpath "$.status" == "RUNNING" # Check the status code
jsonpath "$.tests" count == 25 # Check the number of items
jsonpath "$.id" matches /\d{4}/ # Check the format of the id
```
HTML content
```hurl
GET https://example.org
HTTP 200
[Asserts]
xpath "normalize-space(//head/title)" == "Hello world!"
```
GraphQL
~~~hurl
POST https://example.org/graphql
```graphql
{
human(id: "1000") {
name
height(unit: FOOT)
}
}
```
HTTP 200
~~~
and even SOAP APIs
```hurl
POST https://example.org/InStock
Content-Type: application/soap+xml; charset=utf-8
SOAPAction: "http://www.w3.org/2003/05/soap-envelope"
GOOG
HTTP 200
```
Hurl can also be used to test the performance of HTTP endpoints
```hurl
GET https://example.org/api/v1/pets
HTTP 200
[Asserts]
duration < 1000 # Duration in ms
```
And check response bytes
```hurl
GET https://example.org/data.tar.gz
HTTP 200
[Asserts]
sha256 == hex,039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81;
```
Finally, Hurl is easy to integrate in CI/CD, with text, JUnit, TAP and HTML reports
# Why Hurl?
Text Format: for both devops and developers
Fast CLI: a command line for local dev and continuous integration
Single Binary: easy to install, with no runtime required
# Powered by curl
Hurl is a lightweight binary written in [Rust]. Under the hood, Hurl HTTP engine is
powered by [libcurl], one of the most powerful and reliable file transfer libraries.
With its text file format, Hurl adds syntactic sugar to run and test HTTP requests,
but it's still the [curl] that we love: __fast__, __efficient__ and __HTTP/3 ready__.
# Feedbacks
To support its development, [star Hurl on GitHub]!
[Feedback, suggestion, bugs or improvements] are welcome.
```hurl
POST https://hurl.dev/api/feedback
{
"name": "John Doe",
"feedback": "Hurl is awesome!"
}
HTTP 200
```
# Resources
[License]
[Blog]
[Tutorial]
[Documentation]
[GitHub]
Table of Contents
=================
* [Samples](#samples)
* [Getting Data](#getting-data)
* [HTTP Headers](#http-headers)
* [Query Params](#query-params)
* [Basic Authentication](#basic-authentication)
* [Passing Data between Requests ](#passing-data-between-requests)
* [Sending Data](#sending-data)
* [Sending HTML Form Data](#sending-html-form-data)
* [Sending Multipart Form Data](#sending-multipart-form-data)
* [Posting a JSON Body](#posting-a-json-body)
* [Templating a JSON Body](#templating-a-json-body)
* [Templating a XML Body](#templating-a-xml-body)
* [Using GraphQL Query](#using-graphql-query)
* [Testing Response](#testing-response)
* [Testing Status Code](#testing-status-code)
* [Testing Response Headers](#testing-response-headers)
* [Testing REST APIs](#testing-rest-apis)
* [Testing HTML Response](#testing-html-response)
* [Testing Set-Cookie Attributes](#testing-set-cookie-attributes)
* [Testing Bytes Content](#testing-bytes-content)
* [SSL Certificate](#ssl-certificate)
* [Checking Full Body](#checking-full-body)
* [Reports](#reports)
* [HTML Report](#html-report)
* [JUnit Report](#junit-report)
* [TAP Report](#tap-report)
* [JSON Output](#json-output)
* [Others](#others)
* [HTTP Version](#http-version)
* [Polling and Retry](#polling-and-retry)
* [Delaying Requests](#delaying-requests)
* [Skipping Requests](#skipping-requests)
* [Testing Endpoint Performance](#testing-endpoint-performance)
* [Using SOAP APIs](#using-soap-apis)
* [Capturing and Using a CSRF Token](#capturing-and-using-a-csrf-token)
* [Checking Byte Order Mark (BOM) in Response Body](#checking-byte-order-mark-bom-in-response-body)
* [AWS Signature Version 4 Requests](#aws-signature-version-4-requests)
* [Manual](#manual)
* [Name](#name)
* [Synopsis](#synopsis)
* [Description](#description)
* [Hurl File Format](#hurl-file-format)
* [Capturing values](#capturing-values)
* [Asserts](#asserts)
* [Options](#options)
* [Environment](#environment)
* [Exit Codes](#exit-codes)
* [WWW](#www)
* [See Also](#see-also)
* [Installation](#installation)
* [Binaries Installation](#binaries-installation)
* [Linux](#linux)
* [Debian / Ubuntu](#debian--ubuntu)
* [Alpine](#alpine)
* [Arch Linux / Manjaro](#arch-linux--manjaro)
* [NixOS / Nix](#nixos--nix)
* [macOS](#macos)
* [Homebrew](#homebrew)
* [MacPorts](#macports)
* [FreeBSD](#freebsd)
* [Windows](#windows)
* [Zip File](#zip-file)
* [Installer](#installer)
* [Chocolatey](#chocolatey)
* [Scoop](#scoop)
* [Windows Package Manager](#windows-package-manager)
* [Cargo](#cargo)
* [conda-forge](#conda-forge)
* [Docker](#docker)
* [npm](#npm)
* [Building From Sources](#building-from-sources)
* [Build on Linux](#build-on-linux)
* [Debian based distributions](#debian-based-distributions)
* [Red Hat based distributions](#red-hat-based-distributions)
* [Arch based distributions](#arch-based-distributions)
* [Alpine based distributions](#alpine-based-distributions)
* [Build on macOS](#build-on-macos)
* [Build on Windows](#build-on-windows)
# Samples
To run a sample, edit a file with the sample content, and run Hurl:
```shell
$ vi sample.hurl
GET https://example.org
$ hurl sample.hurl
```
By default, Hurl behaves like [curl] and outputs the last HTTP response's [entry]. To have a test
oriented output, you can use [`--test` option]:
```shell
$ hurl --test sample.hurl
```
A particular response can be saved with [`[Options] section`][option]:
```hurl
GET https://example.ord/cats/123
[Options]
output: cat123.txt # use - to output to stdout
HTTP 200
GET https://example.ord/dogs/567
HTTP 200
```
You can check [Hurl tests suite] for more samples.
## Getting Data
A simple GET:
```hurl
GET https://example.org
```
Requests can be chained:
```hurl
GET https://example.org/a
GET https://example.org/b
HEAD https://example.org/c
GET https://example.org/c
```
[Doc](https://hurl.dev/docs/request.html#method)
### HTTP Headers
A simple GET with headers:
```hurl
GET https://example.org/news
User-Agent: Mozilla/5.0
Accept: */*
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
```
[Doc](https://hurl.dev/docs/request.html#headers)
### Query Params
```hurl
GET https://example.org/news
[QueryStringParams]
order: newest
search: something to search
count: 100
```
Or:
```hurl
GET https://example.org/news?order=newest&search=something%20to%20search&count=100
```
> With `[QueryStringParams]` section, params don't need to be URL escaped.
[Doc](https://hurl.dev/docs/request.html#query-parameters)
### Basic Authentication
```hurl
GET https://example.org/protected
[BasicAuth]
bob: secret
```
[Doc](https://hurl.dev/docs/request.html#basic-authentication)
This is equivalent to construct the request with a [Authorization] header:
```hurl
# Authorization header value can be computed with `echo -n 'bob:secret' | base64`
GET https://example.org/protected
Authorization: Basic Ym9iOnNlY3JldA==
```
Basic authentication section allows per request authentication. If you want to add basic authentication to all the
requests of a Hurl file you could use [`-u/--user` option]:
```shell
$ hurl --user bob:secret login.hurl
```
[`--user`] option can also be set per request:
```hurl
GET https://example.org/login
[Options]
user: bob:secret
HTTP 200
GET https://example.org/login
[Options]
user: alice:secret
HTTP 200
```
### Passing Data between Requests
[Captures] can be used to pass data from one request to another:
```hurl
POST https://sample.org/orders
HTTP 201
[Captures]
order_id: jsonpath "$.order.id"
GET https://sample.org/orders/{{order_id}}
HTTP 200
```
[Doc](https://hurl.dev/docs/capturing-response.html)
## Sending Data
### Sending HTML Form Data
```hurl
POST https://example.org/contact
[FormParams]
default: false
token: {{token}}
email: john.doe@rookie.org
number: 33611223344
```
[Doc](https://hurl.dev/docs/request.html#form-parameters)
### Sending Multipart Form Data
```hurl
POST https://example.org/upload
[MultipartFormData]
field1: value1
field2: file,example.txt;
# One can specify the file content type:
field3: file,example.zip; application/zip
```
[Doc](https://hurl.dev/docs/request.html#multipart-form-data)
Multipart forms can also be sent with a [multiline string body]:
~~~hurl
POST https://example.org/upload
Content-Type: multipart/form-data; boundary="boundary"
```
--boundary
Content-Disposition: form-data; name="key1"
value1
--boundary
Content-Disposition: form-data; name="upload1"; filename="data.txt"
Content-Type: text/plain
Hello World!
--boundary
Content-Disposition: form-data; name="upload2"; filename="data.html"
Content-Type: text/html
Hello World!
--boundary--
```
~~~
In that case, files have to be inlined in the Hurl file.
[Doc](https://hurl.dev/docs/request.html#multiline-string-body)
### Posting a JSON Body
With an inline JSON:
```hurl
POST https://example.org/api/tests
{
"id": "456",
"evaluate": true
}
```
[Doc](https://hurl.dev/docs/request.html#json-body)
With a local file:
```hurl
POST https://example.org/api/tests
Content-Type: application/json
file,data.json;
```
[Doc](https://hurl.dev/docs/request.html#file-body)
### Templating a JSON Body
```hurl
PUT https://example.org/api/hits
Content-Type: application/json
{
"key0": "{{a_string}}",
"key1": {{a_bool}},
"key2": {{a_null}},
"key3": {{a_number}}
}
```
Variables can be initialized via command line:
```shell
$ hurl --variable a_string=apple \
--variable a_bool=true \
--variable a_null=null \
--variable a_number=42 \
test.hurl
```
Resulting in a PUT request with the following JSON body:
```
{
"key0": "apple",
"key1": true,
"key2": null,
"key3": 42
}
```
[Doc](https://hurl.dev/docs/templates.html)
### Templating a XML Body
Using templates with [XML body] is not currently supported in Hurl. You can use templates in
[XML multiline string body] with variables to send a variable XML body:
~~~hurl
POST https://example.org/echo/post/xml
```xml
{{login}}{{password}}
```
~~~
[Doc](https://hurl.dev/docs/request.html#multiline-string-body)
### Using GraphQL Query
A simple GraphQL query:
~~~hurl
POST https://example.org/starwars/graphql
```graphql
{
human(id: "1000") {
name
height(unit: FOOT)
}
}
```
~~~
A GraphQL query with variables:
~~~hurl
POST https://example.org/starwars/graphql
```graphql
query Hero($episode: Episode, $withFriends: Boolean!) {
hero(episode: $episode) {
name
friends @include(if: $withFriends) {
name
}
}
}
variables {
"episode": "JEDI",
"withFriends": false
}
```
~~~
GraphQL queries can also use [Hurl templates].
[Doc](https://hurl.dev/docs/request.html#graphql-body)
## Testing Response
Responses are optional, everything after `HTTP` is part of the response asserts.
```hurl
# A request with (almost) no check:
GET https://foo.com
# A status code check:
GET https://foo.com
HTTP 200
# A test on response body
GET https://foo.com
HTTP 200
[Asserts]
jsonpath "$.state" == "running"
```
### Testing Status Code
```hurl
GET https://example.org/order/435
HTTP 200
```
[Doc](https://hurl.dev/docs/asserting-response.html#version-status)
```hurl
GET https://example.org/order/435
# Testing status code is in a 200-300 range
HTTP *
[Asserts]
status >= 200
status < 300
```
[Doc](https://hurl.dev/docs/asserting-response.html#status-assert)
### Testing Response Headers
Use implicit response asserts to test header values:
```hurl
GET https://example.org/index.html
HTTP 200
Set-Cookie: theme=light
Set-Cookie: sessionToken=abc123; Expires=Wed, 09 Jun 2021 10:18:14 GMT
```
[Doc](https://hurl.dev/docs/asserting-response.html#headers)
Or use explicit response asserts with [predicates]:
```hurl
GET https://example.org
HTTP 302
[Asserts]
header "Location" contains "www.example.net"
```
[Doc](https://hurl.dev/docs/asserting-response.html#header-assert)
Implicit and explicit asserts can be combined:
```hurl
GET https://example.org/index.html
HTTP 200
Set-Cookie: theme=light
Set-Cookie: sessionToken=abc123; Expires=Wed, 09 Jun 2021 10:18:14 GMT
[Asserts]
header "Location" contains "www.example.net"
```
### Testing REST APIs
Asserting JSON body response (node values, collection count etc...) with [JSONPath]:
```hurl
GET https://example.org/order
screencapability: low
HTTP 200
[Asserts]
jsonpath "$.validated" == true
jsonpath "$.userInfo.firstName" == "Franck"
jsonpath "$.userInfo.lastName" == "Herbert"
jsonpath "$.hasDevice" == false
jsonpath "$.links" count == 12
jsonpath "$.state" != null
jsonpath "$.order" matches "^order-\\d{8}$"
jsonpath "$.order" matches /^order-\d{8}$/ # Alternative syntax with regex literal
jsonpath "$.created" isIsoDate
```
[Doc](https://hurl.dev/docs/asserting-response.html#jsonpath-assert)
### Testing HTML Response
```hurl
GET https://example.org
HTTP 200
Content-Type: text/html; charset=UTF-8
[Asserts]
xpath "string(/html/head/title)" contains "Example" # Check title
xpath "count(//p)" == 2 # Check the number of p
xpath "//p" count == 2 # Similar assert for p
xpath "boolean(count(//h2))" == false # Check there is no h2
xpath "//h2" not exists # Similar assert for h2
xpath "string(//div[1])" matches /Hello.*/
```
[Doc](https://hurl.dev/docs/asserting-response.html#xpath-assert)
### Testing Set-Cookie Attributes
```hurl
GET https://example.org/home
HTTP 200
[Asserts]
cookie "JSESSIONID" == "8400BAFE2F66443613DC38AE3D9D6239"
cookie "JSESSIONID[Value]" == "8400BAFE2F66443613DC38AE3D9D6239"
cookie "JSESSIONID[Expires]" contains "Wed, 13 Jan 2021"
cookie "JSESSIONID[Secure]" exists
cookie "JSESSIONID[HttpOnly]" exists
cookie "JSESSIONID[SameSite]" == "Lax"
```
[Doc](https://hurl.dev/docs/asserting-response.html#cookie-assert)
### Testing Bytes Content
Check the SHA-256 response body hash:
```hurl
GET https://example.org/data.tar.gz
HTTP 200
[Asserts]
sha256 == hex,039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81;
```
[Doc](https://hurl.dev/docs/asserting-response.html#sha-256-assert)
### SSL Certificate
Check the properties of a SSL certificate:
```hurl
GET https://example.org
HTTP 200
[Asserts]
certificate "Subject" == "CN=example.org"
certificate "Issuer" == "C=US, O=Let's Encrypt, CN=R3"
certificate "Expire-Date" daysAfterNow > 15
certificate "Serial-Number" matches /[\da-f]+/
```
[Doc](https://hurl.dev/docs/asserting-response.html#ssl-certificate-assert)
### Checking Full Body
Use implicit body to test an exact JSON body match:
```hurl
GET https://example.org/api/cats/123
HTTP 200
{
"name" : "Purrsloud",
"species" : "Cat",
"favFoods" : ["wet food", "dry food", "any food"],
"birthYear" : 2016,
"photo" : "https://learnwebcode.github.io/json-example/images/cat-2.jpg"
}
```
[Doc](https://hurl.dev/docs/asserting-response.html#json-body)
Or an explicit assert file:
```hurl
GET https://example.org/index.html
HTTP 200
[Asserts]
body == file,cat.json;
```
[Doc](https://hurl.dev/docs/asserting-response.html#body-assert)
Implicit asserts supports XML body:
```hurl
GET https://example.org/api/catalog
HTTP 200
Gambardella, MatthewXML Developer's GuideComputer44.952000-10-01An in-depth look at creating applications with XML.
```
[Doc](https://hurl.dev/docs/asserting-response.html#xml-body)
Plain text:
~~~hurl
GET https://example.org/models
HTTP 200
```
Year,Make,Model,Description,Price
1997,Ford,E350,"ac, abs, moon",3000.00
1999,Chevy,"Venture ""Extended Edition""","",4900.00
1999,Chevy,"Venture ""Extended Edition, Very Large""",,5000.00
1996,Jeep,Grand Cherokee,"MUST SELL! air, moon roof, loaded",4799.00
```
~~~
[Doc](https://hurl.dev/docs/asserting-response.html#multiline-string-body)
One line:
```hurl
POST https://example.org/helloworld
HTTP 200
`Hello world!`
```
[Doc](https://hurl.dev/docs/asserting-response.html#oneline-string-body)
File:
```hurl
GET https://example.org
HTTP 200
file,data.bin;
```
[Doc](https://hurl.dev/docs/asserting-response.html#file-body)
## Reports
### HTML Report
```shell
$ hurl --test --report-html build/report/ *.hurl
```
[Doc](https://hurl.dev/docs/running-tests.html#generating-report)
### JUnit Report
```shell
$ hurl --test --report-junit build/report.xml *.hurl
```
[Doc](https://hurl.dev/docs/running-tests.html#generating-report)
### TAP Report
```shell
$ hurl --test --report-tap build/report.txt *.hurl
```
[Doc](https://hurl.dev/docs/running-tests.html#generating-report)
### JSON Output
A structured output of running Hurl files can be obtained with [`--json` option]. Each file will produce a JSON export of the run.
```shell
$ hurl --json *.hurl
```
## Others
### HTTP Version
Testing HTTP version (HTTP/1.0, HTTP/1.1, HTTP/2 or HTTP/3):
```hurl
GET https://foo.com
HTTP/3 200
GET https://bar.com
HTTP/2 200
```
[Doc](https://hurl.dev/docs/asserting-response.html#version-status)
### Polling and Retry
Retry request on any errors (asserts, captures, status code, runtime etc...):
```hurl
# Create a new job
POST https://api.example.org/jobs
HTTP 201
[Captures]
job_id: jsonpath "$.id"
[Asserts]
jsonpath "$.state" == "RUNNING"
# Pull job status until it is completed
GET https://api.example.org/jobs/{{job_id}}
[Options]
retry: 10 # maximum number of retry, -1 for unlimited
HTTP 200
[Asserts]
jsonpath "$.state" == "COMPLETED"
```
[Doc](https://hurl.dev/docs/entry.html#retry)
### Delaying Requests
Add delay for every request, or a particular requests:
```hurl
# Delaying this request by 5s
GET https://example.org/turtle
[Options]
delay: 5000
HTTP 200
# No delay!
GET https://example.org/turtle
HTTP 200
```
[Doc](https://hurl.dev/docs/manual.html#delay)
### Skipping Requests
```hurl
# a, c, d are run, b is skipped
GET https://example.org/a
GET https://example.org/b
[Options]
skip: true
GET https://example.org/c
GET https://example.org/d
```
[Doc](https://hurl.dev/docs/manual.html#skip)
### Testing Endpoint Performance
```hurl
GET https://sample.org/helloworld
HTTP *
[Asserts]
duration < 1000 # Check that response time is less than one second
```
[Doc](https://hurl.dev/docs/asserting-response.html#duration-assert)
### Using SOAP APIs
```hurl
POST https://example.org/InStock
Content-Type: application/soap+xml; charset=utf-8
SOAPAction: "http://www.w3.org/2003/05/soap-envelope"
GOOG
HTTP 200
```
[Doc](https://hurl.dev/docs/request.html#xml-body)
### Capturing and Using a CSRF Token
```hurl
GET https://example.org
HTTP 200
[Captures]
csrf_token: xpath "string(//meta[@name='_csrf_token']/@content)"
POST https://example.org/login?user=toto&password=1234
X-CSRF-TOKEN: {{csrf_token}}
HTTP 302
```
[Doc](https://hurl.dev/docs/capturing-response.html#xpath-capture)
### Checking Byte Order Mark (BOM) in Response Body
```hurl
GET https://example.org/data.bin
HTTP 200
[Asserts]
bytes startsWith hex,efbbbf;
```
[Doc](https://hurl.dev/docs/asserting-response.html#bytes-assert)
### AWS Signature Version 4 Requests
Generate signed API requests with [AWS Signature Version 4], as used by several cloud providers.
```hurl
POST https://sts.eu-central-1.amazonaws.com/
[Options]
aws-sigv4: aws:amz:eu-central-1:sts
[FormParams]
Action: GetCallerIdentity
Version: 2011-06-15
```
The Access Key is given per [`--user`], either with command line option or within the [`[Options]`][option] section:
```hurl
POST https://sts.eu-central-1.amazonaws.com/
[Options]
aws-sigv4: aws:amz:eu-central-1:sts
user: bob=secret
[FormParams]
Action: GetCallerIdentity
Version: 2011-06-15
```
[Doc](https://hurl.dev/docs/manual.html#aws-sigv4)
# Manual
## Name
hurl - run and test HTTP requests.
## Synopsis
**hurl** [options] [FILE...]
## Description
**Hurl** is a command line tool that runs HTTP requests defined in a simple plain text format.
It can chain requests, capture values and evaluate queries on headers and body response. Hurl is very versatile, it can be used for fetching data and testing HTTP sessions: HTML content, REST / SOAP / GraphQL APIs, or any other XML / JSON based APIs.
```shell
$ hurl session.hurl
```
If no input files are specified, input is read from stdin.
```shell
$ 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`](#output) option:
```shell
$ 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`](#test) option:
```shell
$ hurl --test *.hurl
```
## Hurl File Format
The Hurl file format is fully documented in [https://hurl.dev/docs/hurl-file.html](https://hurl.dev/docs/hurl-file.html)
It consists of one or several HTTP requests
```hurl
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.
```hurl
GET https://example.org
HTTP 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](https://hurl.dev/docs/capturing-response.html)
### Asserts
The HTTP response defined in the Hurl file are used to make asserts. Responses are optional.
At the minimum, response includes assert on the HTTP status code.
```hurl
GET http://example.org
HTTP 301
```
It can also include asserts on the response headers
```hurl
GET http://example.org
HTTP 301
Location: http://www.example.org
```
Explicit asserts can be included by combining a query and a predicate
```hurl
GET http://example.org
HTTP 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](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,
except if they are tagged as cli-only (can not be defined in the Hurl request [Options] entry)
For instance:
```shell
$ 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:
```hurl
GET https://example.org
HTTP 301
GET https://example.org
[Options]
location: true
HTTP 200
```
will follow a redirection only for the second entry.
| Option | Description |
|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| --aws-sigv4 <PROVIDER1[:PROVIDER2[:REGION[:SERVICE]]]> | Generate an `Authorization` header with an AWS SigV4 signature.
Use [`-u, --user`](#user) to specify Access Key Id (username) and Secret Key (password).
To use temporary session credentials (e.g. for an AWS IAM Role), add the `X-Amz-Security-Token` header containing the session token. |
| --cacert <FILE> | 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. |
| -E, --cert <CERTIFICATE[:PASSWORD]> | Client certificate file and password.
See also [`--key`](#key). |
| --color | Colorize debug output (the HTTP response output is not colorized).
This is a cli-only option. |
| --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`](#max-time). |
| --connect-to <HOST1:PORT1:HOST2:PORT2> | For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. This option can be used several times in a command line.
See also [`--resolve`](#resolve). |
| --continue-on-error | 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.
This is a cli-only option. |
| -b, --cookie <FILE> | 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> | 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> | Sets delay before each request. |
| --error-format <FORMAT> | Control the format of error message (short by default or long)
This is a cli-only option. |
| --file-root <DIR> | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output. When it is not explicitly defined, files are relative to the Hurl file's directory.
This is a cli-only option. |
| --from-entry <ENTRY_NUMBER> | Execute Hurl file from ENTRY_NUMBER (starting at 1).
This is a cli-only 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.
This is a cli-only option. |
| -0, --http1.0 | Tells Hurl to use HTTP version 1.0 instead of using its internally preferred HTTP version. |
| --http1.1 | Tells Hurl to use HTTP version 1.1. |
| --http2 | Tells Hurl to use HTTP version 2. For HTTPS, this means Hurl negotiates HTTP/2 in the TLS handshake. Hurl does this by default. For HTTP, this means Hurl attempts to upgrade the request to HTTP/2 using the Upgrade: request header. |
| --http3 | Tells Hurl to try HTTP/3 to the host in the URL, but fallback to earlier HTTP versions if the HTTP/3 connection establishment fails. HTTP/3 is only available for HTTPS and not for HTTP URLs. |
| --ignore-asserts | Ignore all asserts defined in the Hurl file.
This is a cli-only option. |
| -i, --include | Include the HTTP headers in the output
This is a cli-only option. |
| -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).
This is a cli-only option. |
| -4, --ipv4 | This option tells Hurl to use IPv4 addresses only when resolving host names, and not for example try IPv6. |
| -6, --ipv6 | This option tells Hurl to use IPv6 addresses only when resolving host names, and not for example try IPv4. |
| --jobs <NUM> | (Experimental) Maximum number of parallel jobs in parallel mode. Default value corresponds (in most cases) to the current amount of CPUs.
See also [`--parallel`](#parallel).
This is a cli-only option. |
| --json | 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. |
| -L, --location | Follow redirect. To limit the amount of redirects to follow use the [`--max-redirs`](#max-redirs) option |
| --location-trusted | Like [`-L, --location`](#location), but allows sending the name + password to all hosts that the site may redirect to. This may or may not introduce a security breach if the site redirects you to a site to which you send your authentication info (which is plaintext in the case of HTTP Basic authentication). |
| --max-filesize <BYTES> | Specify the maximum size (in bytes) of a file to download. If the file requested is larger than this value, the transfer does not start.
This is a cli-only option. |
| --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`](#connect-timeout).
This is a cli-only option. |
| -n, --netrc | Scan the .netrc file in the user's home directory for the username and password.
See also [`--netrc-file`](#netrc-file) and [`--netrc-optional`](#netrc-optional). |
| --netrc-file <FILE> | Like [`--netrc`](#netrc), but provide the path to the netrc file.
See also [`--netrc-optional`](#netrc-optional). |
| --netrc-optional | Similar to [`--netrc`](#netrc), but make the .netrc usage optional.
See also [`--netrc-file`](#netrc-file). |
| --no-color | Do not colorize output.
This is a cli-only option. |
| --no-output | Suppress output. By default, Hurl outputs the body of the last response.
This is a cli-only option. |
| --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. |
| --parallel | (Experimental) Run files in parallel.
Each Hurl file is executed in its own worker thread, without sharing anything with the other workers. The default run mode is sequential.
See also [`--jobs`](#jobs).
This is a cli-only option. |
| --path-as-is | Tell Hurl to not handle sequences of /../ or /./ in the given URL path. Normally Hurl will squash or merge them according to standards but with this option set you tell it not to do that. |
| -x, --proxy <[PROTOCOL://]HOST[:PORT]> | Use the specified proxy. |
| --report-html <DIR> | Generate HTML report in DIR.
If the HTML report already exists, it will be updated with the new test results.
If the FILE report already exists, it will be updated with the new test results.
This is a cli-only option. |
| --resolve <HOST:PORT:ADDR> | Provide a custom address for a specific host and port pair. Using this, you can make the Hurl requests(s) use a specified address and prevent the otherwise normally resolved address to be used. Consider it a sort of /etc/hosts alternative provided on the command line. |
| --retry <NUM> | Maximum number of retries, 0 for no retries, -1 for unlimited retries. Retry happens if any error occurs (asserts, captures, runtimes etc...). |
| --retry-interval <MILLISECONDS> | Duration in milliseconds between each retry. Default is 1000 ms. |
| --ssl-no-revoke | (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 | 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.
This is a cli-only option. |
| --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.
This is a cli-only option. |
| --unix-socket <PATH> | (HTTP) Connect through this Unix domain socket, instead of using the network. |
| -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.
This is a cli-only option. |
| --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`](#variable) option.
Note that defining a variable twice produces an error.
This is a cli-only option. |
| -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`](#include) might be the option you're looking for. |
| --very-verbose | Turn on more verbose output on standard error stream.
In contrast to [`--verbose`](#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`](#proxy) option.
| Variable | Description |
|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `http_proxy [PROTOCOL://][:PORT]` | Sets the proxy server to use for HTTP. |
| `https_proxy [PROTOCOL://][:PORT]` | Sets the proxy server to use for HTTPS. |
| `all_proxy [PROTOCOL://][:PORT]` | Sets the proxy server to use if no protocol-specific proxy is set. |
| `no_proxy ` | 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`](#variable) and [`--variables-file`](#variables-file) options. |
| `NO_COLOR` | When set to a non-empty string, do not colorize output (see [`--no-color`](#no-color) option). |
## Exit Codes
| Value | Description |
|-------|---------------------------------------------------------|
| `0` | Success. |
| `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)
## See Also
curl(1) hurlfmt(1)
# Installation
## Binaries Installation
### Linux
Precompiled binary is available at [Hurl latest GitHub release]:
```shell
$ INSTALL_DIR=/tmp
$ VERSION=4.3.0
$ curl --silent --location https://github.com/Orange-OpenSource/hurl/releases/download/$VERSION/hurl-$VERSION-x86_64-unknown-linux-gnu.tar.gz | tar xvz -C $INSTALL_DIR
$ export PATH=$INSTALL_DIR/hurl-$VERSION-x86_64-unknown-linux-gnu/bin:$PATH
```
#### Debian / Ubuntu
For Debian / Ubuntu, Hurl can be installed using a binary .deb file provided in each Hurl release.
```shell
$ VERSION=4.3.0
$ curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/$VERSION/hurl_${VERSION}_amd64.deb
$ sudo apt update && sudo apt install ./hurl_${VERSION}_amd64.deb
```
#### Alpine
Hurl is available on `testing` channel.
```shell
$ apk add --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing hurl
```
#### Arch Linux / Manjaro
Hurl is available on [extra] channel.
```shell
$ pacman -Sy hurl
```
#### NixOS / Nix
[NixOS / Nix package] is available on stable channel.
### macOS
Precompiled binaries for Intel and ARM CPUs are available at [Hurl latest GitHub release].
#### Homebrew
```shell
$ brew install hurl
```
#### MacPorts
```shell
$ sudo port install hurl
```
### FreeBSD
```shell
$ sudo pkg install hurl
```
### Windows
#### Zip File
Hurl can be installed from a standalone zip file at [Hurl latest GitHub release]. You will need to update your `PATH` variable.
#### Installer
An executable installer is also available at [Hurl latest GitHub release].
#### Chocolatey
```shell
$ choco install hurl
```
#### Scoop
```shell
$ scoop install hurl
```
#### Windows Package Manager
```shell
$ winget install hurl
```
### Cargo
If you're a Rust programmer, Hurl can be installed with cargo.
```shell
$ cargo install hurl
```
### conda-forge
```shell
$ conda install -c conda-forge hurl
```
Hurl can also be installed with [`conda-forge`] powered package manager like [`pixi`].
### Docker
```shell
$ docker pull ghcr.io/orange-opensource/hurl:latest
```
### npm
```shell
$ npm install --save-dev @orangeopensource/hurl
```
## Building From Sources
Hurl sources are available in [GitHub].
### Build on Linux
Hurl depends on libssl, libcurl and libxml2 native libraries. You will need their development files in your platform.
#### Debian based distributions
```shell
$ apt install -y build-essential pkg-config libssl-dev libcurl4-openssl-dev libxml2-dev
```
#### Red Hat based distributions
```shell
$ yum install -y pkg-config gcc openssl-devel libxml2-devel
```
#### Arch based distributions
```shell
$ pacman -S --noconfirm pkgconf gcc glibc openssl libxml2
```
#### Alpine based distributions
```shell
$ apk add curl-dev gcc libxml2-dev musl-dev openssl-dev
```
### Build on macOS
```shell
$ xcode-select --install
$ brew install pkg-config
```
Hurl is written in [Rust]. You should [install] the latest stable release.
```shell
$ curl https://sh.rustup.rs -sSf | sh -s -- -y
$ source $HOME/.cargo/env
$ rustc --version
$ cargo --version
```
Then build hurl:
```shell
$ git clone https://github.com/Orange-OpenSource/hurl
$ cd hurl
$ cargo build --release
$ ./target/release/hurl --version
```
### Build on Windows
Please follow the [contrib on Windows section].
[XPath]: https://en.wikipedia.org/wiki/XPath
[JSONPath]: https://goessner.net/articles/JsonPath/
[Rust]: https://www.rust-lang.org
[curl]: https://curl.se
[the installation section]: https://hurl.dev/docs/installation.html
[Feedback, suggestion, bugs or improvements]: https://github.com/Orange-OpenSource/hurl/issues
[License]: https://hurl.dev/docs/license.html
[Tutorial]: https://hurl.dev/docs/tutorial/your-first-hurl-file.html
[Documentation]: https://hurl.dev/docs/installation.html
[Blog]: https://hurl.dev/blog/
[GitHub]: https://github.com/Orange-OpenSource/hurl
[libcurl]: https://curl.se/libcurl/
[star Hurl on GitHub]: https://github.com/Orange-OpenSource/hurl/stargazers
[JSON body]: https://hurl.dev/docs/request.html#json-body
[XML body]: https://hurl.dev/docs/request.html#xml-body
[XML multiline string body]: https://hurl.dev/docs/request.html#multiline-string-body
[multiline string body]: https://hurl.dev/docs/request.html#multiline-string-body
[predicates]: https://hurl.dev/docs/asserting-response.html#predicates
[JSONPath]: https://goessner.net/articles/JsonPath/
[Basic authentication]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme
[`Authorization` header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
[Hurl tests suite]: https://github.com/Orange-OpenSource/hurl/tree/master/integration/hurl/tests_ok
[Authorization]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
[`-u/--user` option]: https://hurl.dev/docs/manual.html#user
[curl]: https://curl.se
[entry]: https://hurl.dev/docs/entry.html
[`--test` option]: https://hurl.dev/docs/manual.html#test
[`--user`]: https://hurl.dev/docs/manual.html#user
[Hurl templates]: https://hurl.dev/docs/templates.html
[AWS Signature Version 4]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
[Captures]: https://hurl.dev/docs/capturing-response.html
[option]: https://hurl.dev/docs/request.html#options
[`--json` option]: https://hurl.dev/docs/manual.html#json
[GitHub]: https://github.com/Orange-OpenSource/hurl
[Hurl latest GitHub release]: https://github.com/Orange-OpenSource/hurl/releases/latest
[install]: https://www.rust-lang.org/tools/install
[Rust]: https://www.rust-lang.org
[contrib on Windows section]: https://github.com/Orange-OpenSource/hurl/blob/master/contrib/windows/README.md
[NixOS / Nix package]: https://search.nixos.org/packages?from=0&size=1&sort=relevance&type=packages&query=hurl
[`conda-forge`]: https://conda-forge.org
[`pixi`]: https://prefix.dev
[extra]: https://archlinux.org/packages/extra/x86_64/hurl/
It is well adapted for REST / JSON APIs
```hurl
POST https://example.org/api/tests
{
"id": "4568",
"evaluate": true
}
HTTP 200
[Asserts]
header "X-Frame-Options" == "SAMEORIGIN"
jsonpath "$.status" == "RUNNING" # Check the status code
jsonpath "$.tests" count == 25 # Check the number of items
jsonpath "$.id" matches /\d{4}/ # Check the format of the id
```
HTML content
```hurl
GET https://example.org
HTTP 200
[Asserts]
xpath "normalize-space(//head/title)" == "Hello world!"
```
GraphQL
~~~hurl
POST https://example.org/graphql
```graphql
{
human(id: "1000") {
name
height(unit: FOOT)
}
}
```
HTTP 200
~~~
and even SOAP APIs
```hurl
POST https://example.org/InStock
Content-Type: application/soap+xml; charset=utf-8
SOAPAction: "http://www.w3.org/2003/05/soap-envelope"
