hurl/docs/manual/hurlfmt.md
2023-06-28 15:19:55 +00:00

1.9 KiB

NAME

hurlfmt - format Hurl files

SYNOPSIS

hurlfmt [options] [FILE...]

DESCRIPTION

hurlfmt formats Hurl files and converts them from/to other formats.

With no FILE, read standard input.

By default, hurlfmt outputs a formatted and colorized version of the input hurl file.

$ hurl hello.hurl
GET http://localhost:8000/hello

HTTP/1.0 200

hurlfmt can be used to convert to other format.

$ hurl hello.hurl --output json | jq
{
  "entries": [
    {
      "request": {
        "method": "GET",
        "url": "http://localhost:8000/hello"
      },
      "response": {
        "version": "HTTP/1.0",
        "status": 200
      }
    }
  ]
}

hurlfmt can also be used to convert a curl command-line to Hurl

$ echo "curl http://localhost:8000/custom-headers -H 'Fruit:Raspberry'" | hurlfmt --in curl
GET http://localhost:8000/custom-headers
Fruit: Raspberry

OPTIONS

--check

Run in 'check' mode. Exits with 0 if input is formatted correctly, 1 otherwise.

This can not be used with --output.

This option is not stable yet.

--color

Colorize Output.

This can not be used --in-place.

-h, --help

Usage help.

--in

Specify input format: hurl (default) or curl

--inplace

Modify file in place.

This can be used only with text output.

--no-color

Do not colorize Output.

--out

Specify output format: hurl (default), json or html

-o, --output

Write output to instead of stdout.

--standalone

Output full html file with css instead of html fragment (default).

This can be used only with html output.

-V, --version

Prints version information

EXIT CODES

1

Failed to parse command-line options.

2

Input File Parsing Error.

WWW

https://hurl.dev

SEE ALSO

hurl(1)