<commit_before>HTTPie: human-friendly CLI HTTP client for the API era
######################################################

HTTPie (pronounced *aitch-tee-tee-pie*) is a command-line HTTP client.
Its goal is to make CLI interaction with web services as human-friendly as possible.
HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.
The ``http`` & ``https`` commands allow for creating and sending arbitrary HTTP requests.
They use simple and natural syntax and provide formatted and colorized output.



.. class:: no-web no-pdf

    |docs| |pypi| |build| |coverage| |downloads| |gitter|


.. class:: no-web no-pdf

    .. image:: https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif
        :alt: HTTPie in action
        :width: 100%
        :align: center


.. contents::

.. section-numbering::


About this document
===================

This documentation is best viewed at `httpie.org/docs <https://httpie.org/docs>`_.

You can select your corresponding HTTPie version as well as run examples directly from the
browser using a `termible.io <https://termible.io?utm_source=httpie-readme>`_ embedded terminal.

If you are reading this on GitHub, then this text covers the current *development* version.
You are invited to submit fixes and improvements to the the docs by editing
`README.rst <https://github.com/httpie/httpie/blob/master/README.rst>`_.


Main features
=============

* Expressive and intuitive syntax
* Formatted and colorized terminal output
* Built-in JSON support
* Forms and file uploads
* HTTPS, proxies, and authentication
* Arbitrary request data
* Custom headers
* Persistent sessions
* Wget-like downloads
* Linux, macOS and Windows support
* Plugins
* Documentation
* Test coverage


.. class:: no-web

    .. image:: https://raw.githubusercontent.com/httpie/httpie/master/httpie.png
        :alt: HTTPie compared to cURL
        :width: 100%
        :align: center


Installation
============


macOS
-----


On macOS, HTTPie can be installed via `Homebrew <https://brew.sh/>`_
(recommended):

.. code-block:: bash

    $ brew install httpie


A MacPorts *port* is also available:

.. code-block:: bash

    $ port install httpie

Linux
-----

Most Linux distributions provide a package that can be installed using the
system package manager, for example:

.. code-block:: bash

    # Debian, Ubuntu, etc.
    $ apt install httpie

.. code-block:: bash

    # Fedora
    $ dnf install httpie

.. code-block:: bash

    # CentOS, RHEL, ...
    $ yum install httpie

.. code-block:: bash

    # Gentoo
    $ emerge httpie

.. code-block:: bash

    # Arch Linux
    $ pacman -S httpie

.. code-block:: bash

    # Solus
    $ eopkg install httpie


Windows, etc.
-------------

A universal installation method (that works on Windows, macOS, Linux, …,
and always provides the latest version) is to use `pip`_:

.. code-block:: bash

    # Make sure we have an up-to-date version of pip and setuptools:
    $ python -m pip install --upgrade pip setuptools

    $ python -m pip install --upgrade httpie


(If ``pip`` installation fails for some reason, you can try
``easy_install httpie`` as a fallback.)

Windows users can also install HTTPie with `Chocolatey <https://chocolatey.org>`_:

.. code-block:: bash

    $ choco upgrade httpie


Python version
--------------

Python version 3.6 or greater is required.


Unstable version
----------------

You can also install the latest unreleased development version directly from
the ``master`` branch on GitHub.  It is a work-in-progress of a future stable
release so the experience might be not as smooth.


.. class:: no-pdf

|build|


On macOS you can install it with Homebrew:

.. code-block:: bash

    $ brew uninstall --force httpie
    $ brew install --HEAD httpie


Otherwise with ``pip``:

.. code-block:: bash

    $ python -m pip install --upgrade https://github.com/httpie/httpie/archive/master.tar.gz


Verify that now we have the
`current development version identifier <https://github.com/httpie/httpie/blob/master/httpie/__init__.py#L6>`_
with the ``-dev`` suffix, for example:

.. code-block:: bash

    $ http --version
    # 2.0.0-dev


Usage
=====


Hello World:


.. code-block:: bash

    $ https httpie.io/hello


Synopsis:

.. code-block:: bash

    $ http [flags] [METHOD] URL [ITEM [ITEM]]


See also ``http --help``.


Examples
--------

Custom `HTTP method`_, `HTTP headers`_ and `JSON`_ data:

.. code-block:: bash

    $ http PUT pie.dev/put X-API-Token:<PASSWORD> name=John


Submitting `forms`_:

.. code-block:: bash

    $ http -f POST pie.dev/post hello=World


See the request that is being sent using one of the `output options`_:

.. code-block:: bash

    $ http -v pie.dev/get


Build and print a request without sending it using `offline mode`_:

.. code-block:: bash

    $ http --offline pie.dev/post hello=offline


Use `GitHub API`_ to post a comment on an
`issue <https://github.com/httpie/httpie/issues/83>`_
with `authentication`_:

.. code-block:: bash

    $ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'


Upload a file using `redirected input`_:

.. code-block:: bash

    $ http pie.dev/post < files/data.json


Download a file and save it via `redirected output`_:

.. code-block:: bash

    $ http pie.dev/image/png > image.png


Download a file ``wget`` style:

.. code-block:: bash

    $ http --download pie.dev/image/png

Use named `sessions`_ to make certain aspects of the communication persistent
between requests to the same host:


.. code-block:: bash

    $ http --session=logged-in -a username:password pie.dev/get API-Key:123


.. code-block:: bash

    $ http --session=logged-in pie.dev/headers


Set a custom ``Host`` header to work around missing DNS records:

.. code-block:: bash

    $ http localhost:8000 Host:example.com

..


HTTP method
===========

The name of the HTTP method comes right before the URL argument:

.. code-block:: bash

    $ http DELETE pie.dev/delete


Which looks similar to the actual ``Request-Line`` that is sent:

.. code-block:: http

    DELETE /delete HTTP/1.1


When the ``METHOD`` argument is omitted from the command, HTTPie defaults to
either ``GET`` (with no request data) or ``POST`` (with request data).


Request URL
===========

The only information HTTPie needs to perform a request is a URL.

The default scheme is ``http://`` and can be omitted from the argument:

.. code-block:: bash

    $ http example.org
    # => http://example.org


HTTPie also installs an ``https`` executable, where the default
scheme is ``https://``:


.. code-block:: bash

    $ https example.org
    # => https://example.org


Querystring parameters
----------------------

If you find yourself manually constructing URLs with querystring parameters
on the terminal, you may appreciate the ``param==value`` syntax for appending
URL parameters.

With that, you don’t have to worry about escaping the ``&``
separators for your shell. Additionally, any special characters in the
parameter name or value get automatically URL-escaped
(as opposed to parameters specified in the full URL, which HTTPie doesn’t
modify).

.. code-block:: bash

    $ http https://api.github.com/search/repositories q==httpie per_page==1


.. code-block:: http

    GET /search/repositories?q=httpie&per_page=1 HTTP/1.1



URL shortcuts for ``localhost``
-------------------------------

Additionally, curl-like shorthand for localhost is supported.
This means that, for example ``:3000`` would expand to ``http://localhost:3000``
If the port is omitted, then port 80 is assumed.

.. code-block:: bash

    $ http :/foo


.. code-block:: http

    GET /foo HTTP/1.1
    Host: localhost


.. code-block:: bash

    $ http :3000/bar


.. code-block:: http

    GET /bar HTTP/1.1
    Host: localhost:3000


.. code-block:: bash

    $ http :


.. code-block:: http

    GET / HTTP/1.1
    Host: localhost


Other default schemes
---------------------

When HTTPie is invoked as ``https`` then the default scheme is ``https://``
(``$ https example.org`` will make a request to ``https://example.org``).

You can also use the ``--default-scheme <URL_SCHEME>`` option to create
shortcuts for other protocols than HTTP (possibly supported via plugins).
Example for the `httpie-unixsocket <https://github.com/httpie/httpie-unixsocket>`_ plugin:

.. code-block:: bash

    # Before
    $ http http+unix://%2Fvar%2Frun%2Fdocker.sock/info


.. code-block:: bash

    # Create an alias
    $ alias http-unix='http --default-scheme="http+unix"'


.. code-block:: bash

    # Now the scheme can be omitted
    $ http-unix %2Fvar%2Frun%2Fdocker.sock/info


``--path-as-is``
----------------

The standard behaviour of HTTP clients is to normalize the path portion of URLs by squashing dot segments
as a typically filesystem would:


.. code-block:: bash

    $ http -v example.org/./../../etc/password

.. code-block:: http

    GET /etc/password HTTP/1.1


The ``--path-as-is`` option allows you to disable this behavior:

.. code-block:: bash

    $ http --path-as-is -v example.org/./../../etc/password

.. code-block:: http

    GET /../../etc/password HTTP/1.1


Request items
=============

There are a few different *request item* types that provide a
convenient mechanism for specifying HTTP headers, simple JSON and
form data, files, and URL parameters.

They are key/value pairs specified after the URL. All have in
common that they become part of the actual request that is sent and that
their type is distinguished only by the separator used:
``:``, ``=``, ``:=``, ``==``, ``@``, ``=@``, and ``:=@``. The ones with an
``@`` expect a file path as value.

+------------------------------+---------------------------------------------------+
| Item Type                    | Description                                       |
+==============================+===================================================+
| HTTP Headers                 | Arbitrary HTTP header, e.g. ``X-API-Token:123``.  |
| ``Name:Value``               |                                                   |
+------------------------------+---------------------------------------------------+
| URL parameters               | Appends the given name/value pair as a query      |
| ``name==value``              | string parameter to the URL.                      |
|                              | The ``==`` separator is used.                     |
+------------------------------+---------------------------------------------------+
| Data Fields                  | Request data fields to be serialized as a JSON    |
| ``field=value``,             | object (default), to be form-encoded              |
| ``field=@<EMAIL>.txt``          | (with ``--form, -f``), or to be serialized as     |
|                              | ``multipart/form-data`` (with ``--multipart``).   |
+------------------------------+---------------------------------------------------+
| Raw JSON fields              | Useful when sending JSON and one or               |
| ``field:=json``,             | more fields need to be a ``Boolean``, ``Number``, |
| ``field:=@file.json``        | nested ``Object``, or an ``Array``,  e.g.,        |
|                              | ``meals:='["ham","spam"]'`` or ``pies:=[1,2,3]``  |
|                              | (note the quotes).                                |
+------------------------------+---------------------------------------------------+
| Fields upload fields         | Only available with ``--form, -f`` and            |
| ``field@/dir/file``          | ``--multipart``.                                  |
| ``field@file;type=mime``     | For example ``screenshot@~/Pictures/img.png``, or |
|                              | ``'<EMAIL>;type=text/markdown'``.               |
|                              | With ``--form``, the presence of a file field     |
|                              | results in a ``--multipart`` request.             |
+------------------------------+---------------------------------------------------+


Note that the structured data fields aren’t the only way to specify request data:
The `raw request body`_ section describes mechanisms for passing arbitrary request data.


Escaping rules
--------------

You can use ``\`` to escape characters that shouldn’t be used as separators
(or parts thereof). For instance, ``foo\==bar`` will become a data key/value
pair (``foo=`` and ``bar``) instead of a URL parameter.

Often it is necessary to quote the values, e.g. ``foo='bar baz'``.

If any of the field names or headers starts with a minus
(e.g., ``-fieldname``), you need to place all such items after the special
token ``--`` to prevent confusion with ``--arguments``:

.. code-block:: bash

    $ http pie.dev/post  --  -name-starting-with-dash=foo -Unusual-Header:bar

.. code-block:: http

    POST /post HTTP/1.1
    -Unusual-Header: bar
    Content-Type: application/json

    {
        "-name-starting-with-dash": "foo"
    }



JSON
====

JSON is the *lingua franca* of modern web services and it is also the
**implicit content type** HTTPie uses by default.


Simple example:

.. code-block:: bash

    $ http PUT pie.dev/put name=John email=<EMAIL>

.. code-block:: http

    PUT / HTTP/1.1
    Accept: application/json, */*;q=0.5
    Accept-Encoding: gzip, deflate
    Content-Type: application/json
    Host: pie.dev

    {
        "name": "John",
        "email": "<EMAIL>"
    }


Default behaviour
-----------------


If your command includes some data `request items`_, they are serialized as a JSON
object by default. HTTPie also automatically sets the following headers,
both of which can be overwritten:

================    =======================================
``Content-Type``    ``application/json``
``Accept``          ``application/json, */*;q=0.5``
================    =======================================


Explicit JSON
-------------

You can use ``--json, -j`` to explicitly set ``Accept``
to ``application/json`` regardless of whether you are sending data
(it’s a shortcut for setting the header via the usual header notation:
``http url Accept:'application/json, */*;q=0.5'``). Additionally,
HTTPie will try to detect JSON responses even when the
``Content-Type`` is incorrectly ``text/plain`` or unknown.



Non-string JSON fields
----------------------

Non-string JSON fields use the ``:=`` separator, which allows you to embed arbitrary JSON data
into the resulting JSON object. Additionally, text and raw JSON files can also be embedded into
fields using ``=@`` and ``:=@``:

.. code-block:: bash

    $ http PUT pie.dev/put \
        name=John \                        # String (default)
        age:=29 \                          # Raw JSON — Number
        married:=false \                   # Raw JSON — Boolean
        hobbies:='["http", "pies"]' \      # Raw JSON — Array
        favorite:='{"tool": "HTTPie"}' \   # Raw JSON — Object
        bookmarks:=@files/data.json \      # Embed JSON file
        description=@files/text.txt        # Embed text file


.. code-block:: http

    PUT /person/1 HTTP/1.1
    Accept: application/json, */*;q=0.5
    Content-Type: application/json
    Host: pie.dev

    {
        "age": 29,
        "hobbies": [
            "http",
            "pies"
        ],
        "description": "John is a nice guy who likes pies.",
        "married": false,
        "name": "John",
        "favorite": {
            "tool": "HTTPie"
        },
        "bookmarks": {
            "HTTPie": "https://httpie.org",
        }
    }


Raw and complex JSON
--------------------

Please note that with the structured `request items`_ data field syntax, commands
can quickly become unwieldy when sending complex structures.
In such cases, it’s better to pass the full raw JSON data as a `raw request body`_, for example:

.. code-block:: bash

    $ echo -n '{"hello": "world"}' | http POST pie.dev/post

.. code-block:: bash

    $ http --raw '{"hello": "world"}' POST pie.dev/post

.. code-block:: bash

    $ http POST pie.dev/post < files/data.json

Furthermore, the structure syntax only allows you to send an object as the JSON document, but not an array, etc.
Here, again, the solution is to use a `raw request body`_.

Forms
=====

Submitting forms is very similar to sending `JSON`_ requests. Often the only
difference is in adding the ``--form, -f`` option, which ensures that
data fields are serialized as, and ``Content-Type`` is set to,
``application/x-www-form-urlencoded; charset=utf-8``. It is possible to make
form data the implicit content type instead of JSON
via the `config`_ file.


Regular forms
-------------

.. code-block:: bash

    $ http --form POST pie.dev/post name='<NAME>'


.. code-block:: http

    POST /post HTTP/1.1
    Content-Type: application/x-www-form-urlencoded; charset=utf-8

    name=John+Smith


File upload forms
-----------------

If one or more file fields is present, the serialization and content type is
``multipart/form-data``:

.. code-block:: bash

    $ http -f POST pie.dev/post name='<NAME>' cv@~/files/data.xml


The request above is the same as if the following HTML form were
submitted:

.. code-block:: html

    <form enctype="multipart/form-data" method="post" action="http://example.com/jobs">
        <input type="text" name="name" />
        <input type="file" name="cv" />
    </form>

Please note that ``@`` is used to simulate a file upload form field, whereas
``=@`` just embeds the file content as a regular text field value.

When uploading files, their content type is inferred from the file name. You can manually
override the inferred content type:

.. code-block:: bash

   $ http -f POST pie.dev/post name='<NAME>' cv@'~/files/data.bin;type=application/pdf'

To perform a ``multipart/form-data`` request even without any files, use
``--multipart`` instead of ``--form``:

.. code-block:: bash

    $ http --multipart --offline example.org hello=world

.. code-block:: http

    POST / HTTP/1.1
    Content-Length: 129
    Content-Type: multipart/form-data; boundary=c31279ab254f40aeb06df32b433cbccb
    Host: example.org

    --c31279ab254f40aeb06df32b433cbccb
    Content-Disposition: form-data; name="hello"

    world
    --c31279ab254f40aeb06df32b433cbccb--

File uploads are always streamed to avoid memory issues with large files.

By default, HTTPie uses a random unique string as the multipart boundary
but you can use ``--boundary`` to specify a custom string instead:

.. code-block:: bash

    $ http --form --multipart --boundary=xoxo --offline example.org hello=world

.. code-block:: http

    POST / HTTP/1.1
    Content-Length: 129
    Content-Type: multipart/form-data; boundary=xoxo
    Host: example.org

    --xoxo
    Content-Disposition: form-data; name="hello"

    world
    --xoxo--

If you specify a custom ``Content-Type`` header without including the boundary
bit, HTTPie will add the boundary value (explicitly specified or auto-generated)
to the header automatically:


.. code-block:: bash

    http --form --multipart --offline example.org hello=world Content-Type:multipart/letter

.. code-block:: http

    POST / HTTP/1.1
    Content-Length: 129
    Content-Type: multipart/letter; boundary=c31279ab254f40aeb06df32b433cbccb
    Host: example.org

    --c31279ab254f40aeb06df32b433cbccb
    Content-Disposition: form-data; name="hello"

    world
    --c31279ab254f40aeb06df32b433cbccb--


HTTP headers
============

To set custom headers you can use the ``Header:Value`` notation:

.. code-block:: bash

    $ http pie.dev/headers  User-Agent:Bacon/1.0  'Cookie:valued-visitor=yes;foo=bar'  \
        X-Foo:Bar  Referer:https://httpie.org/


.. code-block:: http

    GET /headers HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Cookie: valued-visitor=yes;foo=bar
    Host: pie.dev
    Referer: https://httpie.org/
    User-Agent: Bacon/1.0
    X-Foo: Bar


Default request headers
-----------------------

There are a couple of default headers that HTTPie sets:

.. code-block:: http

    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    User-Agent: HTTPie/<version>
    Host: <taken-from-URL>



Any of these can be overwritten and some of them unset (see below).



Empty headers and header un-setting
-----------------------------------

To unset a previously specified header
(such a one of the default headers), use ``Header:``:


.. code-block:: bash

    $ http pie.dev/headers Accept: User-Agent:


To send a header with an empty value, use ``Header;``:


.. code-block:: bash

    $ http pie.dev/headers 'Header;'


Limiting response headers
-------------------------

The ``--max-headers=n`` options allows you to control the number of headers
HTTPie reads before giving up (the default ``0``, i.e., there’s no limit).


.. code-block:: bash

    $ http --max-headers=100 pie.dev/get



Offline mode
============

Use ``--offline`` to construct HTTP requests without sending them anywhere.
With ``--offline``, HTTPie builds a request based on the specified options and arguments, prints it to ``stdout``,
and then exits. It works completely offline; no network connection is ever made.
This has a number of use cases, including:


Generating API documentation examples that you can copy & paste without sending a request:


.. code-block:: bash

    $ http --offline POST server.chess/api/games API-Key:ZZZ w=magnus b=hikaru t=180 i=2


.. code-block:: bash

    $ http --offline MOVE server.chess/api/games/123 API-Key:ZZZ p=b a=R1a3 t=77


Generating raw requests that can be sent with any other client:

.. code-block:: bash

    # 1. save a raw request to a file:
    $ http --offline POST pie.dev/post hello=world > request.http


.. code-block:: bash

    # 2. send it over the wire with, for example, the fantastic netcat tool:
    $ nc pie.dev 80 < request.http


You can also use the ``--offline`` mode for debugging and exploring HTTP and HTTPie, and for “dry runs”.

``--offline`` has the side-effect of automatically activating ``--print=HB``, i.e., both the request headers and the body
are printed. You can customize the output with the usual `output options`_, with the exception that there
is not response to be printed. You can use ``--offline`` in combination with all the other options (e.g., ``--session``).



Cookies
=======

HTTP clients send cookies to the server as regular `HTTP headers`_. That means,
HTTPie does not offer any special syntax for specifying cookies — the usual
``Header:Value`` notation is used:


Send a single cookie:

.. code-block:: bash

    $ http pie.dev/cookies Cookie:sessionid=foo

.. code-block:: http

    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Connection: keep-alive
    Cookie: sessionid=foo
    Host: pie.dev
    User-Agent: HTTPie/0.9.9


Send multiple cookies
(note the header is quoted to prevent the shell from interpreting the ``;``):

.. code-block:: bash

    $ http pie.dev/cookies 'Cookie:sessionid=foo;another-cookie=bar'

.. code-block:: http

    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Connection: keep-alive
    Cookie: sessionid=foo;another-cookie=bar
    Host: pie.dev
    User-Agent: HTTPie/0.9.9


If you often deal with cookies in your requests, then chances are you’d appreciate
the `sessions`_ feature.


Authentication
==============

The currently supported authentication schemes are Basic and Digest
(see `auth plugins`_ for more). There are two flags that control authentication:

===================     ======================================================
``--auth, -a``          Pass a ``username:password`` pair as
                        the argument. Or, if you only specify a username
                        (``-a username``), you’ll be prompted for
                        the password before the request is sent.
                        To send an empty password, pass ``username:``.
                        The ``username:password@hostname`` URL syntax is
                        supported as well (but credentials passed via ``-a``
                        have higher priority).

``--auth-type, -A``     Specify the auth mechanism. Possible values are
                        ``basic``, ``digest``, or the name of any `auth plugins`_ you have installed. The default value is
                        ``basic`` so it can often be omitted.
===================     ======================================================



Basic auth
----------


.. code-block:: bash

    $ http -a username:password pie.dev/basic-auth/username/password


Digest auth
-----------


.. code-block:: bash

    $ http -A digest -a username:password pie.dev/digest-auth/httpie/username/password


Password prompt
---------------

.. code-block:: bash

    $ http -a username pie.dev/basic-auth/username/password


Empty password
--------------

.. code-block:: bash

    $ http -a username: pie.dev/headers


``.netrc``
----------

Authentication information from your ``~/.netrc``
file is by default honored as well.

For example:

.. code-block:: bash

    $ cat ~/.netrc
    machine pie.dev
    login httpie
    password <PASSWORD>

.. code-block:: bash

    $ http pie.dev/basic-auth/httpie/test
    HTTP/1.1 200 OK
    [...]

This can be disabled with the ``--ignore-netrc`` option:

.. code-block:: bash

    $ http --ignore-netrc pie.dev/basic-auth/httpie/test
    HTTP/1.1 401 UNAUTHORIZED
    [...]


Auth plugins
------------

Additional authentication mechanism can be installed as plugins.
They can be found on the `Python Package Index <https://pypi.python.org/pypi?%3Aaction=search&term=httpie&submit=search>`_.
Here’s a few picks:

* `httpie-api-auth <https://github.com/pd/httpie-api-auth>`_: ApiAuth
* `httpie-aws-auth <https://github.com/httpie/httpie-aws-auth>`_: AWS / Amazon S3
* `httpie-edgegrid <https://github.com/akamai-open/httpie-edgegrid>`_: EdgeGrid
* `httpie-hmac-auth <https://github.com/guardian/httpie-hmac-auth>`_: HMAC
* `httpie-jwt-auth <https://github.com/teracyhq/httpie-jwt-auth>`_: JWTAuth (JSON Web Tokens)
* `httpie-negotiate <https://github.com/ndzou/httpie-negotiate>`_: SPNEGO (GSS Negotiate)
* `httpie-ntlm <https://github.com/httpie/httpie-ntlm>`_: NTLM (NT LAN Manager)
* `httpie-oauth <https://github.com/httpie/httpie-oauth>`_: OAuth
* `requests-hawk <https://github.com/mozilla-services/requests-hawk>`_: Hawk




HTTP redirects
==============

By default, HTTP redirects are not followed and only the first
response is shown:


.. code-block:: bash

    $ http pie.dev/redirect/3


Follow ``Location``
-------------------

To instruct HTTPie to follow the ``Location`` header of ``30x`` responses
and show the final response instead, use the ``--follow, -F`` option:


.. code-block:: bash

    $ http --follow pie.dev/redirect/3


With ``307 Temporary Redirect`` and ``308 Permanent Redirect``, the method and the body of the original request
are reused to perform the redirected request. Otherwise, a body-less ``GET`` request is performed.


Showing intermediary redirect responses
---------------------------------------

If you additionally wish to see the intermediary requests/responses,
then use the ``--all`` option as well:


.. code-block:: bash

    $ http --follow --all pie.dev/redirect/3



Limiting maximum redirects followed
-----------------------------------

To change the default limit of maximum ``30`` redirects, use the
``--max-redirects=<limit>`` option:


.. code-block:: bash

    $ http --follow --all --max-redirects=2 pie.dev/redirect/3


Proxies
=======

You can specify proxies to be used through the ``--proxy`` argument for each
protocol (which is included in the value in case of redirects across protocols):

.. code-block:: bash

    $ http --proxy=http:http://10.10.1.10:3128 --proxy=https:https://10.10.1.10:1080 example.org


With Basic authentication:

.. code-block:: bash

    $ http --proxy=http:http://user:pass@10.10.1.10:3128 example.org


Environment variables
---------------------

You can also configure proxies by environment variables ``ALL_PROXY``,
``HTTP_PROXY`` and ``HTTPS_PROXY``, and the underlying Requests library will
pick them up as well. If you want to disable proxies configured through
the environment variables for certain hosts, you can specify them in ``NO_PROXY``.

In your ``~/.bash_profile``:

.. code-block:: bash

 export HTTP_PROXY=http://10.10.1.10:3128
 export HTTPS_PROXY=https://10.10.1.10:1080
 export NO_PROXY=localhost,example.com


SOCKS
-----

Usage is the same as for other types of `proxies`_:

.. code-block:: bash

    $ http --proxy=http:socks5://user:pass@host:port --proxy=https:socks5://user:pass@host:port example.org


HTTPS
=====


Server SSL certificate verification
-----------------------------------

To skip the host’s SSL certificate verification, you can pass ``--verify=no``
(default is ``yes``):

.. code-block:: bash

    $ http --verify=no https://pie.dev/get


Custom CA bundle
----------------

You can also use ``--verify=<CA_BUNDLE_PATH>`` to set a custom CA bundle path:

.. code-block:: bash

    $ http --verify=/ssl/custom_ca_bundle https://example.org



Client side SSL certificate
---------------------------
To use a client side certificate for the SSL communication, you can pass
the path of the cert file with ``--cert``:

.. code-block:: bash

    $ http --cert=client.pem https://example.org


If the private key is not contained in the cert file you may pass the
path of the key file with ``--cert-key``:

.. code-block:: bash

    $ http --cert=client.crt --cert-key=client.key https://example.org


SSL version
-----------

Use the ``--ssl=<PROTOCOL>`` option to specify the desired protocol version to
use. This will default to SSL v2.3 which will negotiate the highest protocol
that both the server and your installation of OpenSSL support. The available
protocols are
``ssl2.3``, ``ssl3``, ``tls1``, ``tls1.1``, ``tls1.2``, ``tls1.3``.
(The actually available set of protocols may vary depending on your OpenSSL
installation.)

.. code-block:: bash

    # Specify the vulnerable SSL v3 protocol to talk to an outdated server:
    $ http --ssl=ssl3 https://vulnerable.example.org



SSL ciphers
-----------

You can specify the available ciphers with ``--ciphers``.
It should be a string in the
`OpenSSL cipher list format <https://www.openssl.org/docs/man1.1.0/man1/ciphers.html>`_.

.. code-block:: bash

    $ http --ciphers=ECDHE-RSA-AES128-GCM-SHA256  https://pie.dev/get

Note: these cipher strings do not change the negotiated version of SSL or TLS,
they only affect the list of available cipher suites.

To see the default cipher string, run ``http --help`` and see
the ``--ciphers`` section under SSL.



Output options
==============

By default, HTTPie only outputs the final response and the whole response
message is printed (headers as well as the body). You can control what should
be printed via several options:

=================   =====================================================
``--headers, -h``   Only the response headers are printed.
``--body, -b``      Only the response body is printed.
``--verbose, -v``   Print the whole HTTP exchange (request and response).
                    This option also enables ``--all`` (see below).
``--print, -p``     Selects parts of the HTTP exchange.
``--quiet, -q``     Don't print anything to ``stdout`` and ``stderr``.
=================   =====================================================


What parts of the HTTP exchange should be printed
-------------------------------------------------

All the other `output options`_ are under the hood just shortcuts for
the more powerful ``--print, -p``. It accepts a string of characters each
of which represents a specific part of the HTTP exchange:

==========  ==================
Character   Stands for
==========  ==================
``H``       request headers
``B``       request body
``h``       response headers
``b``       response body
==========  ==================

Print request and response headers:

.. code-block:: bash

    $ http --print=Hh PUT pie.dev/put hello=world

Verbose output
--------------

``--verbose`` can often be useful for debugging the request and generating
documentation examples:

.. code-block:: bash

    $ http --verbose PUT pie.dev/put hello=world
    PUT /put HTTP/1.1
    Accept: application/json, */*;q=0.5
    Accept-Encoding: gzip, deflate
    Content-Type: application/json
    Host: pie.dev
    User-Agent: HTTPie/0.2.7dev

    {
        "hello": "world"
    }


    HTTP/1.1 200 OK
    Connection: keep-alive
    Content-Length: 477
    Content-Type: application/json
    Date: Sun, 05 Aug 2012 00:25:23 GMT
    Server: gunicorn/0.13.4

    {
        […]
    }

Quiet output
------------

``--quiet`` redirects all output that would otherwise go to ``stdout``
and ``stderr`` to ``/dev/null`` (except for errors and warnings).
This doesn’t affect output to a file via ``--output`` or ``--download``.

.. code-block:: bash

    # There will be no output:
    $ http --quiet pie.dev/post enjoy='the silence'


Viewing intermediary requests/responses
---------------------------------------

To see all the HTTP communication, i.e. the final request/response as
well as any possible  intermediary requests/responses, use the ``--all``
option. The intermediary HTTP communication include followed redirects
(with ``--follow``), the first unauthorized request when HTTP digest
authentication is used (``--auth=digest``), etc.

.. code-block:: bash

    # Include all responses that lead to the final one:
    $ http --all --follow pie.dev/redirect/3


The intermediary requests/response are by default formatted according to
``--print, -p`` (and its shortcuts described above). If you’d like to change
that, use the ``--history-print, -P`` option. It takes the same
arguments as ``--print, -p`` but applies to the intermediary requests only.


.. code-block:: bash

    # Print the intermediary requests/responses differently than the final one:
    $ http -A digest -a foo:bar --all -p Hh -P H pie.dev/digest-auth/auth/foo/bar


Conditional body download
-------------------------

As an optimization, the response body is downloaded from the server
only if it’s part of the output. This is similar to performing a ``HEAD``
request, except that it applies to any HTTP method you use.

Let’s say that there is an API that returns the whole resource when it is
updated, but you are only interested in the response headers to see the
status code after an update:

.. code-block:: bash

    $ http --headers PATCH pie.dev/patch name='New Name'


Since we are only printing the HTTP headers here, the connection to the server
is closed as soon as all the response headers have been received.
Therefore, bandwidth and time isn’t wasted downloading the body
which you don’t care about. The response headers are downloaded always,
even if they are not part of the output


Raw request body
================

In addition to crafting structured `JSON`_ and `forms`_ requests with the
`request items`_ syntax, you can provide a raw request body that will be
sent without further processing. These two approaches for specifying request
data (i.e., structured and raw) cannot be combined.

There’re three methods for passing raw request data: piping via ``stdin``,
``--raw='data'``, and ``@/file/path``.


Redirected Input
----------------

The universal method for passing request data is through redirected ``stdin``
(standard input)—piping.

By default, ``stdin`` data is buffered and then with no further processing
used as the request body. If you provide ``Content-Length``, then the request
body is streamed without buffering. You can also use ``--chunked`` to enable
streaming via `chunked transfer encoding`_.

There are multiple useful ways to use piping:

Redirect from a file:

.. code-block:: bash

    $ http PUT pie.dev/put X-API-Token:123 < files/data.json


Or the output of another program:

.. code-block:: bash

    $ grep '401 Unauthorized' /var/log/httpd/error_log | http POST pie.dev/post


You can use ``echo`` for simple data:

.. code-block:: bash

    $ echo -n '{"name": "John"}' | http PATCH pie.dev/patch X-API-Token:<PASSWORD>


You can also use a Bash *here string*:

.. code-block:: bash

    $ http pie.dev/post <<<'{"name": "John"}'


You can even pipe web services together using HTTPie:

.. code-block:: bash

    $ http GET https://api.github.com/repos/httpie/httpie | http POST pie.dev/post


You can use ``cat`` to enter multiline data on the terminal:

.. code-block:: bash

    $ cat | http POST pie.dev/post
    <paste>
    ^D


.. code-block:: bash

    $ cat | http POST pie.dev/post Content-Type:text/plain
    - buy milk
    - call parents
    ^D


On OS X, you can send the contents of the clipboard with ``pbpaste``:

.. code-block:: bash

    $ pbpaste | http PUT pie.dev/put


Passing data through ``stdin`` cannot be combined with data fields specified
on the command line:

.. code-block:: bash

    $ echo -n 'data' | http POST example.org more=data   # This is invalid


To prevent HTTPie from reading ``stdin`` data you can use the
``--ignore-stdin`` option.


Request data via ``--raw``
--------------------------

In a situation when piping data via ``stdin`` is not convenient (for example,
when generating API docs examples), you can specify the raw request body via
the ``--raw`` option.

.. code-block:: bash

    $ http --raw 'Hello, world!' pie.dev/post

.. code-block:: bash

    $ http --raw '{"name": "John"}' pie.dev/post


Request data from a filename
----------------------------

An alternative to redirected ``stdin`` is specifying a filename (as
``@/path/to/file``) whose content is used as if it came from ``stdin``.

It has the advantage that the ``Content-Type``
header is automatically set to the appropriate value based on the
filename extension. For example, the following request sends the
verbatim contents of that XML file with ``Content-Type: application/xml``:

.. code-block:: bash

    $ http PUT pie.dev/put @files/data.xml

File uploads are always streamed to avoid memory issues with large files.


Chunked transfer encoding
=========================

You can use the ``--chunked`` flag to instruct HTTPie to use
``Transfer-Encoding: chunked``:


.. code-block:: bash

    $ http --chunked PUT pie.dev/put hello=world

.. code-block:: bash

    $ http --chunked --multipart PUT pie.dev/put hello=world foo@files/data.xml

.. code-block:: bash

    $ http --chunked pie.dev/post @files/data.xml

.. code-block:: bash

    $ cat files/data.xml | http --chunked pie.dev/post



Terminal output
===============

HTTPie does several things by default in order to make its terminal output
easy to read.


Colors and formatting
---------------------

Syntax highlighting is applied to HTTP headers and bodies (where it makes
sense). You can choose your preferred color scheme via the ``--style`` option
if you don’t like the default one. There dozens of styles available, here are just a few special or notable ones:

====================   ========================================================================
``auto``               Follows your terminal ANSI color styles. This is the default style used by HTTPie.
``default``            Default styles of the underlying Pygments library. Not actually used by default by HTTPie.
                       You can enable it with ``--style=default``
``monokai``            A popular color scheme. Enable with ``--style=monokai``.
``fruity``             A bold, colorful scheme. Enable with ``--style=fruity``.
…                      See ``$ http --help`` for all the possible ``--style`` values.
====================   ========================================================================

Also, the following formatting is applied:

* HTTP headers are sorted by name.
* JSON data is indented, sorted by keys, and unicode escapes are converted
  to the characters they represent.

One of these options can be used to control output processing:

====================   ========================================================
``--pretty=all``       Apply both colors and formatting.
                       Default for terminal output.
``--pretty=colors``    Apply colors.
``--pretty=format``    Apply formatting.
``--pretty=none``      Disables output processing.
                       Default for redirected output.
====================   ========================================================

You can control the applied formatting via the `formatting options`_.


Formatting options
------------------

The following options are available:

+-------------------------------+---------------+------------------------------+
| Option                        | Default value | Shortcut(s)                  |
+===============================+===============+==============================+
| ``headers.sort``              | ``true``      | ``--sorted``, ``--unsorted`` |
+-------------------------------+---------------+------------------------------+
| ``json.format``               | ``true``      | N/A                          |
+-------------------------------+---------------+------------------------------+
| ``json.indent``               | ``4``         | N/A                          |
+--------------------+----------+---------------+------------------------------+
| ``json.sort_keys``            | ``true``      | ``--sorted``, ``--unsorted`` |
+--------------------+----------+---------------+------------------------------+

For example, this is how you would disable the default header and JSON key
sorting, and specify a custom JSON indent size:

.. code-block:: bash

    $ http --format-options headers.sort:false,json.sort_keys:false,json.indent:2 pie.dev/get

There are also shortcuts that allow you to quickly disable and re-enable options.
For example, ``--sorted`` and ``--unsorted`` arguments would respectively enable
and disable sorting-related format options:

.. code-block:: bash

    $ http --sorted pie.dev/get
    $ http --unsorted pie.dev/get

This is something you will typically store as one of the default options in your `config`_ file.


Binary data
-----------

Binary data is suppressed for terminal output, which makes it safe to perform
requests to URLs that send back binary data. Binary data is suppressed also in
redirected, but prettified output. The connection is closed as soon as we know
that the response body is binary,

.. code-block:: bash

    $ http pie.dev/bytes/2000


You will nearly instantly see something like this:

.. code-block:: http

    HTTP/1.1 200 OK<commit_msg>Tweak format options docs<commit_after>HTTPie: human-friendly CLI HTTP client for the API era
######################################################

HTTPie (pronounced *aitch-tee-tee-pie*) is a command-line HTTP client.
Its goal is to make CLI interaction with web services as human-friendly as possible.
HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.
The ``http`` & ``https`` commands allow for creating and sending arbitrary HTTP requests.
They use simple and natural syntax and provide formatted and colorized output.



.. class:: no-web no-pdf

    |docs| |pypi| |build| |coverage| |downloads| |gitter|


.. class:: no-web no-pdf

    .. image:: https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif
        :alt: HTTPie in action
        :width: 100%
        :align: center


.. contents::

.. section-numbering::


About this document
===================

This documentation is best viewed at `httpie.org/docs <https://httpie.org/docs>`_.

You can select your corresponding HTTPie version as well as run examples directly from the
browser using a `termible.io <https://termible.io?utm_source=httpie-readme>`_ embedded terminal.

If you are reading this on GitHub, then this text covers the current *development* version.
You are invited to submit fixes and improvements to the the docs by editing
`README.rst <https://github.com/httpie/httpie/blob/master/README.rst>`_.


Main features
=============

* Expressive and intuitive syntax
* Formatted and colorized terminal output
* Built-in JSON support
* Forms and file uploads
* HTTPS, proxies, and authentication
* Arbitrary request data
* Custom headers
* Persistent sessions
* Wget-like downloads
* Linux, macOS and Windows support
* Plugins
* Documentation
* Test coverage


.. class:: no-web

    .. image:: https://raw.githubusercontent.com/httpie/httpie/master/httpie.png
        :alt: HTTPie compared to cURL
        :width: 100%
        :align: center


Installation
============


macOS
-----


On macOS, HTTPie can be installed via `Homebrew <https://brew.sh/>`_
(recommended):

.. code-block:: bash

    $ brew install httpie


A MacPorts *port* is also available:

.. code-block:: bash

    $ port install httpie

Linux
-----

Most Linux distributions provide a package that can be installed using the
system package manager, for example:

.. code-block:: bash

    # Debian, Ubuntu, etc.
    $ apt install httpie

.. code-block:: bash

    # Fedora
    $ dnf install httpie

.. code-block:: bash

    # CentOS, RHEL, ...
    $ yum install httpie

.. code-block:: bash

    # Gentoo
    $ emerge httpie

.. code-block:: bash

    # Arch Linux
    $ pacman -S httpie

.. code-block:: bash

    # Solus
    $ eopkg install httpie


Windows, etc.
-------------

A universal installation method (that works on Windows, macOS, Linux, …,
and always provides the latest version) is to use `pip`_:

.. code-block:: bash

    # Make sure we have an up-to-date version of pip and setuptools:
    $ python -m pip install --upgrade pip setuptools

    $ python -m pip install --upgrade httpie


(If ``pip`` installation fails for some reason, you can try
``easy_install httpie`` as a fallback.)

Windows users can also install HTTPie with `Chocolatey <https://chocolatey.org>`_:

.. code-block:: bash

    $ choco upgrade httpie


Python version
--------------

Python version 3.6 or greater is required.


Unstable version
----------------

You can also install the latest unreleased development version directly from
the ``master`` branch on GitHub.  It is a work-in-progress of a future stable
release so the experience might be not as smooth.


.. class:: no-pdf

|build|


On macOS you can install it with Homebrew:

.. code-block:: bash

    $ brew uninstall --force httpie
    $ brew install --HEAD httpie


Otherwise with ``pip``:

.. code-block:: bash

    $ python -m pip install --upgrade https://github.com/httpie/httpie/archive/master.tar.gz


Verify that now we have the
`current development version identifier <https://github.com/httpie/httpie/blob/master/httpie/__init__.py#L6>`_
with the ``-dev`` suffix, for example:

.. code-block:: bash

    $ http --version
    # 2.0.0-dev


Usage
=====


Hello World:


.. code-block:: bash

    $ https httpie.io/hello


Synopsis:

.. code-block:: bash

    $ http [flags] [METHOD] URL [ITEM [ITEM]]


See also ``http --help``.


Examples
--------

Custom `HTTP method`_, `HTTP headers`_ and `JSON`_ data:

.. code-block:: bash

    $ http PUT pie.dev/put X-API-Token:<PASSWORD> name=John


Submitting `forms`_:

.. code-block:: bash

    $ http -f POST pie.dev/post hello=World


See the request that is being sent using one of the `output options`_:

.. code-block:: bash

    $ http -v pie.dev/get


Build and print a request without sending it using `offline mode`_:

.. code-block:: bash

    $ http --offline pie.dev/post hello=offline


Use `GitHub API`_ to post a comment on an
`issue <https://github.com/httpie/httpie/issues/83>`_
with `authentication`_:

.. code-block:: bash

    $ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'


Upload a file using `redirected input`_:

.. code-block:: bash

    $ http pie.dev/post < files/data.json


Download a file and save it via `redirected output`_:

.. code-block:: bash

    $ http pie.dev/image/png > image.png


Download a file ``wget`` style:

.. code-block:: bash

    $ http --download pie.dev/image/png

Use named `sessions`_ to make certain aspects of the communication persistent
between requests to the same host:


.. code-block:: bash

    $ http --session=logged-in -a username:password pie.dev/get API-Key:123


.. code-block:: bash

    $ http --session=logged-in pie.dev/headers


Set a custom ``Host`` header to work around missing DNS records:

.. code-block:: bash

    $ http localhost:8000 Host:example.com

..


HTTP method
===========

The name of the HTTP method comes right before the URL argument:

.. code-block:: bash

    $ http DELETE pie.dev/delete


Which looks similar to the actual ``Request-Line`` that is sent:

.. code-block:: http

    DELETE /delete HTTP/1.1


When the ``METHOD`` argument is omitted from the command, HTTPie defaults to
either ``GET`` (with no request data) or ``POST`` (with request data).


Request URL
===========

The only information HTTPie needs to perform a request is a URL.

The default scheme is ``http://`` and can be omitted from the argument:

.. code-block:: bash

    $ http example.org
    # => http://example.org


HTTPie also installs an ``https`` executable, where the default
scheme is ``https://``:


.. code-block:: bash

    $ https example.org
    # => https://example.org


Querystring parameters
----------------------

If you find yourself manually constructing URLs with querystring parameters
on the terminal, you may appreciate the ``param==value`` syntax for appending
URL parameters.

With that, you don’t have to worry about escaping the ``&``
separators for your shell. Additionally, any special characters in the
parameter name or value get automatically URL-escaped
(as opposed to parameters specified in the full URL, which HTTPie doesn’t
modify).

.. code-block:: bash

    $ http https://api.github.com/search/repositories q==httpie per_page==1


.. code-block:: http

    GET /search/repositories?q=httpie&per_page=1 HTTP/1.1



URL shortcuts for ``localhost``
-------------------------------

Additionally, curl-like shorthand for localhost is supported.
This means that, for example ``:3000`` would expand to ``http://localhost:3000``
If the port is omitted, then port 80 is assumed.

.. code-block:: bash

    $ http :/foo


.. code-block:: http

    GET /foo HTTP/1.1
    Host: localhost


.. code-block:: bash

    $ http :3000/bar


.. code-block:: http

    GET /bar HTTP/1.1
    Host: localhost:3000


.. code-block:: bash

    $ http :


.. code-block:: http

    GET / HTTP/1.1
    Host: localhost


Other default schemes
---------------------

When HTTPie is invoked as ``https`` then the default scheme is ``https://``
(``$ https example.org`` will make a request to ``https://example.org``).

You can also use the ``--default-scheme <URL_SCHEME>`` option to create
shortcuts for other protocols than HTTP (possibly supported via plugins).
Example for the `httpie-unixsocket <https://github.com/httpie/httpie-unixsocket>`_ plugin:

.. code-block:: bash

    # Before
    $ http http+unix://%2Fvar%2Frun%2Fdocker.sock/info


.. code-block:: bash

    # Create an alias
    $ alias http-unix='http --default-scheme="http+unix"'


.. code-block:: bash

    # Now the scheme can be omitted
    $ http-unix %2Fvar%2Frun%2Fdocker.sock/info


``--path-as-is``
----------------

The standard behaviour of HTTP clients is to normalize the path portion of URLs by squashing dot segments
as a typically filesystem would:


.. code-block:: bash

    $ http -v example.org/./../../etc/password

.. code-block:: http

    GET /etc/password HTTP/1.1


The ``--path-as-is`` option allows you to disable this behavior:

.. code-block:: bash

    $ http --path-as-is -v example.org/./../../etc/password

.. code-block:: http

    GET /../../etc/password HTTP/1.1


Request items
=============

There are a few different *request item* types that provide a
convenient mechanism for specifying HTTP headers, simple JSON and
form data, files, and URL parameters.

They are key/value pairs specified after the URL. All have in
common that they become part of the actual request that is sent and that
their type is distinguished only by the separator used:
``:``, ``=``, ``:=``, ``==``, ``@``, ``=@``, and ``:=@``. The ones with an
``@`` expect a file path as value.

+------------------------------+---------------------------------------------------+
| Item Type                    | Description                                       |
+==============================+===================================================+
| HTTP Headers                 | Arbitrary HTTP header, e.g. ``X-API-Token:123``.  |
| ``Name:Value``               |                                                   |
+------------------------------+---------------------------------------------------+
| URL parameters               | Appends the given name/value pair as a query      |
| ``name==value``              | string parameter to the URL.                      |
|                              | The ``==`` separator is used.                     |
+------------------------------+---------------------------------------------------+
| Data Fields                  | Request data fields to be serialized as a JSON    |
| ``field=value``,             | object (default), to be form-encoded              |
| ``field=@<EMAIL>``          | (with ``--form, -f``), or to be serialized as     |
|                              | ``multipart/form-data`` (with ``--multipart``).   |
+------------------------------+---------------------------------------------------+
| Raw JSON fields              | Useful when sending JSON and one or               |
| ``field:=json``,             | more fields need to be a ``Boolean``, ``Number``, |
| ``field:=@file.json``        | nested ``Object``, or an ``Array``,  e.g.,        |
|                              | ``meals:='["ham","spam"]'`` or ``pies:=[1,2,3]``  |
|                              | (note the quotes).                                |
+------------------------------+---------------------------------------------------+
| Fields upload fields         | Only available with ``--form, -f`` and            |
| ``field@/dir/file``          | ``--multipart``.                                  |
| ``field@file;type=mime``     | For example ``screenshot@~/Pictures/img.png``, or |
|                              | ``'<EMAIL>;type=text/markdown'``.               |
|                              | With ``--form``, the presence of a file field     |
|                              | results in a ``--multipart`` request.             |
+------------------------------+---------------------------------------------------+


Note that the structured data fields aren’t the only way to specify request data:
The `raw request body`_ section describes mechanisms for passing arbitrary request data.


Escaping rules
--------------

You can use ``\`` to escape characters that shouldn’t be used as separators
(or parts thereof). For instance, ``foo\==bar`` will become a data key/value
pair (``foo=`` and ``bar``) instead of a URL parameter.

Often it is necessary to quote the values, e.g. ``foo='bar baz'``.

If any of the field names or headers starts with a minus
(e.g., ``-fieldname``), you need to place all such items after the special
token ``--`` to prevent confusion with ``--arguments``:

.. code-block:: bash

    $ http pie.dev/post  --  -name-starting-with-dash=foo -Unusual-Header:bar

.. code-block:: http

    POST /post HTTP/1.1
    -Unusual-Header: bar
    Content-Type: application/json

    {
        "-name-starting-with-dash": "foo"
    }



JSON
====

JSON is the *lingua franca* of modern web services and it is also the
**implicit content type** HTTPie uses by default.


Simple example:

.. code-block:: bash

    $ http PUT pie.dev/put name=John email=<EMAIL>

.. code-block:: http

    PUT / HTTP/1.1
    Accept: application/json, */*;q=0.5
    Accept-Encoding: gzip, deflate
    Content-Type: application/json
    Host: pie.dev

    {
        "name": "John",
        "email": "<EMAIL>"
    }


Default behaviour
-----------------


If your command includes some data `request items`_, they are serialized as a JSON
object by default. HTTPie also automatically sets the following headers,
both of which can be overwritten:

================    =======================================
``Content-Type``    ``application/json``
``Accept``          ``application/json, */*;q=0.5``
================    =======================================


Explicit JSON
-------------

You can use ``--json, -j`` to explicitly set ``Accept``
to ``application/json`` regardless of whether you are sending data
(it’s a shortcut for setting the header via the usual header notation:
``http url Accept:'application/json, */*;q=0.5'``). Additionally,
HTTPie will try to detect JSON responses even when the
``Content-Type`` is incorrectly ``text/plain`` or unknown.



Non-string JSON fields
----------------------

Non-string JSON fields use the ``:=`` separator, which allows you to embed arbitrary JSON data
into the resulting JSON object. Additionally, text and raw JSON files can also be embedded into
fields using ``=@`` and ``:=@``:

.. code-block:: bash

    $ http PUT pie.dev/put \
        name=John \                        # String (default)
        age:=29 \                          # Raw JSON — Number
        married:=false \                   # Raw JSON — Boolean
        hobbies:='["http", "pies"]' \      # Raw JSON — Array
        favorite:='{"tool": "HTTPie"}' \   # Raw JSON — Object
        bookmarks:=@files/data.json \      # Embed JSON file
        description=@files/text.txt        # Embed text file


.. code-block:: http

    PUT /person/1 HTTP/1.1
    Accept: application/json, */*;q=0.5
    Content-Type: application/json
    Host: pie.dev

    {
        "age": 29,
        "hobbies": [
            "http",
            "pies"
        ],
        "description": "John is a nice guy who likes pies.",
        "married": false,
        "name": "John",
        "favorite": {
            "tool": "HTTPie"
        },
        "bookmarks": {
            "HTTPie": "https://httpie.org",
        }
    }


Raw and complex JSON
--------------------

Please note that with the structured `request items`_ data field syntax, commands
can quickly become unwieldy when sending complex structures.
In such cases, it’s better to pass the full raw JSON data as a `raw request body`_, for example:

.. code-block:: bash

    $ echo -n '{"hello": "world"}' | http POST pie.dev/post

.. code-block:: bash

    $ http --raw '{"hello": "world"}' POST pie.dev/post

.. code-block:: bash

    $ http POST pie.dev/post < files/data.json

Furthermore, the structure syntax only allows you to send an object as the JSON document, but not an array, etc.
Here, again, the solution is to use a `raw request body`_.

Forms
=====

Submitting forms is very similar to sending `JSON`_ requests. Often the only
difference is in adding the ``--form, -f`` option, which ensures that
data fields are serialized as, and ``Content-Type`` is set to,
``application/x-www-form-urlencoded; charset=utf-8``. It is possible to make
form data the implicit content type instead of JSON
via the `config`_ file.


Regular forms
-------------

.. code-block:: bash

    $ http --form POST pie.dev/post name='<NAME>'


.. code-block:: http

    POST /post HTTP/1.1
    Content-Type: application/x-www-form-urlencoded; charset=utf-8

    name=John+Smith


File upload forms
-----------------

If one or more file fields is present, the serialization and content type is
``multipart/form-data``:

.. code-block:: bash

    $ http -f POST pie.dev/post name='<NAME>' cv@~/files/data.xml


The request above is the same as if the following HTML form were
submitted:

.. code-block:: html

    <form enctype="multipart/form-data" method="post" action="http://example.com/jobs">
        <input type="text" name="name" />
        <input type="file" name="cv" />
    </form>

Please note that ``@`` is used to simulate a file upload form field, whereas
``=@`` just embeds the file content as a regular text field value.

When uploading files, their content type is inferred from the file name. You can manually
override the inferred content type:

.. code-block:: bash

   $ http -f POST pie.dev/post name='<NAME>' cv@'~/files/data.bin;type=application/pdf'

To perform a ``multipart/form-data`` request even without any files, use
``--multipart`` instead of ``--form``:

.. code-block:: bash

    $ http --multipart --offline example.org hello=world

.. code-block:: http

    POST / HTTP/1.1
    Content-Length: 129
    Content-Type: multipart/form-data; boundary=c31279ab254f40aeb06df32b433cbccb
    Host: example.org

    --c31279ab254f40aeb06df32b433cbccb
    Content-Disposition: form-data; name="hello"

    world
    --c31279ab254f40aeb06df32b433cbccb--

File uploads are always streamed to avoid memory issues with large files.

By default, HTTPie uses a random unique string as the multipart boundary
but you can use ``--boundary`` to specify a custom string instead:

.. code-block:: bash

    $ http --form --multipart --boundary=xoxo --offline example.org hello=world

.. code-block:: http

    POST / HTTP/1.1
    Content-Length: 129
    Content-Type: multipart/form-data; boundary=xoxo
    Host: example.org

    --xoxo
    Content-Disposition: form-data; name="hello"

    world
    --xoxo--

If you specify a custom ``Content-Type`` header without including the boundary
bit, HTTPie will add the boundary value (explicitly specified or auto-generated)
to the header automatically:


.. code-block:: bash

    http --form --multipart --offline example.org hello=world Content-Type:multipart/letter

.. code-block:: http

    POST / HTTP/1.1
    Content-Length: 129
    Content-Type: multipart/letter; boundary=c31279ab254f40aeb06df32b433cbccb
    Host: example.org

    --c31279ab254f40aeb06df32b433cbccb
    Content-Disposition: form-data; name="hello"

    world
    --c31279ab254f40aeb06df32b433cbccb--


HTTP headers
============

To set custom headers you can use the ``Header:Value`` notation:

.. code-block:: bash

    $ http pie.dev/headers  User-Agent:Bacon/1.0  'Cookie:valued-visitor=yes;foo=bar'  \
        X-Foo:Bar  Referer:https://httpie.org/


.. code-block:: http

    GET /headers HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Cookie: valued-visitor=yes;foo=bar
    Host: pie.dev
    Referer: https://httpie.org/
    User-Agent: Bacon/1.0
    X-Foo: Bar


Default request headers
-----------------------

There are a couple of default headers that HTTPie sets:

.. code-block:: http

    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    User-Agent: HTTPie/<version>
    Host: <taken-from-URL>



Any of these can be overwritten and some of them unset (see below).



Empty headers and header un-setting
-----------------------------------

To unset a previously specified header
(such a one of the default headers), use ``Header:``:


.. code-block:: bash

    $ http pie.dev/headers Accept: User-Agent:


To send a header with an empty value, use ``Header;``:


.. code-block:: bash

    $ http pie.dev/headers 'Header;'


Limiting response headers
-------------------------

The ``--max-headers=n`` options allows you to control the number of headers
HTTPie reads before giving up (the default ``0``, i.e., there’s no limit).


.. code-block:: bash

    $ http --max-headers=100 pie.dev/get



Offline mode
============

Use ``--offline`` to construct HTTP requests without sending them anywhere.
With ``--offline``, HTTPie builds a request based on the specified options and arguments, prints it to ``stdout``,
and then exits. It works completely offline; no network connection is ever made.
This has a number of use cases, including:


Generating API documentation examples that you can copy & paste without sending a request:


.. code-block:: bash

    $ http --offline POST server.chess/api/games API-Key:ZZZ w=magnus b=hikaru t=180 i=2


.. code-block:: bash

    $ http --offline MOVE server.chess/api/games/123 API-Key:ZZZ p=b a=R1a3 t=77


Generating raw requests that can be sent with any other client:

.. code-block:: bash

    # 1. save a raw request to a file:
    $ http --offline POST pie.dev/post hello=world > request.http


.. code-block:: bash

    # 2. send it over the wire with, for example, the fantastic netcat tool:
    $ nc pie.dev 80 < request.http


You can also use the ``--offline`` mode for debugging and exploring HTTP and HTTPie, and for “dry runs”.

``--offline`` has the side-effect of automatically activating ``--print=HB``, i.e., both the request headers and the body
are printed. You can customize the output with the usual `output options`_, with the exception that there
is not response to be printed. You can use ``--offline`` in combination with all the other options (e.g., ``--session``).



Cookies
=======

HTTP clients send cookies to the server as regular `HTTP headers`_. That means,
HTTPie does not offer any special syntax for specifying cookies — the usual
``Header:Value`` notation is used:


Send a single cookie:

.. code-block:: bash

    $ http pie.dev/cookies Cookie:sessionid=foo

.. code-block:: http

    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Connection: keep-alive
    Cookie: sessionid=foo
    Host: pie.dev
    User-Agent: HTTPie/0.9.9


Send multiple cookies
(note the header is quoted to prevent the shell from interpreting the ``;``):

.. code-block:: bash

    $ http pie.dev/cookies 'Cookie:sessionid=foo;another-cookie=bar'

.. code-block:: http

    GET / HTTP/1.1
    Accept: */*
    Accept-Encoding: gzip, deflate
    Connection: keep-alive
    Cookie: sessionid=foo;another-cookie=bar
    Host: pie.dev
    User-Agent: HTTPie/0.9.9


If you often deal with cookies in your requests, then chances are you’d appreciate
the `sessions`_ feature.


Authentication
==============

The currently supported authentication schemes are Basic and Digest
(see `auth plugins`_ for more). There are two flags that control authentication:

===================     ======================================================
``--auth, -a``          Pass a ``username:password`` pair as
                        the argument. Or, if you only specify a username
                        (``-a username``), you’ll be prompted for
                        the password before the request is sent.
                        To send an empty password, pass ``username:``.
                        The ``username:password@hostname`` URL syntax is
                        supported as well (but credentials passed via ``-a``
                        have higher priority).

``--auth-type, -A``     Specify the auth mechanism. Possible values are
                        ``basic``, ``digest``, or the name of any `auth plugins`_ you have installed. The default value is
                        ``basic`` so it can often be omitted.
===================     ======================================================



Basic auth
----------


.. code-block:: bash

    $ http -a username:password pie.dev/basic-auth/username/password


Digest auth
-----------


.. code-block:: bash

    $ http -A digest -a username:password pie.dev/digest-auth/httpie/username/password


Password prompt
---------------

.. code-block:: bash

    $ http -a username pie.dev/basic-auth/username/password


Empty password
--------------

.. code-block:: bash

    $ http -a username: pie.dev/headers


``.netrc``
----------

Authentication information from your ``~/.netrc``
file is by default honored as well.

For example:

.. code-block:: bash

    $ cat ~/.netrc
    machine pie.dev
    login httpie
    password <PASSWORD>

.. code-block:: bash

    $ http pie.dev/basic-auth/httpie/test
    HTTP/1.1 200 OK
    [...]

This can be disabled with the ``--ignore-netrc`` option:

.. code-block:: bash

    $ http --ignore-netrc pie.dev/basic-auth/httpie/test
    HTTP/1.1 401 UNAUTHORIZED
    [...]


Auth plugins
------------

Additional authentication mechanism can be installed as plugins.
They can be found on the `Python Package Index <https://pypi.python.org/pypi?%3Aaction=search&term=httpie&submit=search>`_.
Here’s a few picks:

* `httpie-api-auth <https://github.com/pd/httpie-api-auth>`_: ApiAuth
* `httpie-aws-auth <https://github.com/httpie/httpie-aws-auth>`_: AWS / Amazon S3
* `httpie-edgegrid <https://github.com/akamai-open/httpie-edgegrid>`_: EdgeGrid
* `httpie-hmac-auth <https://github.com/guardian/httpie-hmac-auth>`_: HMAC
* `httpie-jwt-auth <https://github.com/teracyhq/httpie-jwt-auth>`_: JWTAuth (JSON Web Tokens)
* `httpie-negotiate <https://github.com/ndzou/httpie-negotiate>`_: SPNEGO (GSS Negotiate)
* `httpie-ntlm <https://github.com/httpie/httpie-ntlm>`_: NTLM (NT LAN Manager)
* `httpie-oauth <https://github.com/httpie/httpie-oauth>`_: OAuth
* `requests-hawk <https://github.com/mozilla-services/requests-hawk>`_: Hawk




HTTP redirects
==============

By default, HTTP redirects are not followed and only the first
response is shown:


.. code-block:: bash

    $ http pie.dev/redirect/3


Follow ``Location``
-------------------

To instruct HTTPie to follow the ``Location`` header of ``30x`` responses
and show the final response instead, use the ``--follow, -F`` option:


.. code-block:: bash

    $ http --follow pie.dev/redirect/3


With ``307 Temporary Redirect`` and ``308 Permanent Redirect``, the method and the body of the original request
are reused to perform the redirected request. Otherwise, a body-less ``GET`` request is performed.


Showing intermediary redirect responses
---------------------------------------

If you additionally wish to see the intermediary requests/responses,
then use the ``--all`` option as well:


.. code-block:: bash

    $ http --follow --all pie.dev/redirect/3



Limiting maximum redirects followed
-----------------------------------

To change the default limit of maximum ``30`` redirects, use the
``--max-redirects=<limit>`` option:


.. code-block:: bash

    $ http --follow --all --max-redirects=2 pie.dev/redirect/3


Proxies
=======

You can specify proxies to be used through the ``--proxy`` argument for each
protocol (which is included in the value in case of redirects across protocols):

.. code-block:: bash

    $ http --proxy=http:http://10.10.1.10:3128 --proxy=https:https://10.10.1.10:1080 example.org


With Basic authentication:

.. code-block:: bash

    $ http --proxy=http:http://user:pass@10.10.1.10:3128 example.org


Environment variables
---------------------

You can also configure proxies by environment variables ``ALL_PROXY``,
``HTTP_PROXY`` and ``HTTPS_PROXY``, and the underlying Requests library will
pick them up as well. If you want to disable proxies configured through
the environment variables for certain hosts, you can specify them in ``NO_PROXY``.

In your ``~/.bash_profile``:

.. code-block:: bash

 export HTTP_PROXY=http://10.10.1.10:3128
 export HTTPS_PROXY=https://10.10.1.10:1080
 export NO_PROXY=localhost,example.com


SOCKS
-----

Usage is the same as for other types of `proxies`_:

.. code-block:: bash

    $ http --proxy=http:socks5://user:pass@host:port --proxy=https:socks5://user:pass@host:port example.org


HTTPS
=====


Server SSL certificate verification
-----------------------------------

To skip the host’s SSL certificate verification, you can pass ``--verify=no``
(default is ``yes``):

.. code-block:: bash

    $ http --verify=no https://pie.dev/get


Custom CA bundle
----------------

You can also use ``--verify=<CA_BUNDLE_PATH>`` to set a custom CA bundle path:

.. code-block:: bash

    $ http --verify=/ssl/custom_ca_bundle https://example.org



Client side SSL certificate
---------------------------
To use a client side certificate for the SSL communication, you can pass
the path of the cert file with ``--cert``:

.. code-block:: bash

    $ http --cert=client.pem https://example.org


If the private key is not contained in the cert file you may pass the
path of the key file with ``--cert-key``:

.. code-block:: bash

    $ http --cert=client.crt --cert-key=client.key https://example.org


SSL version
-----------

Use the ``--ssl=<PROTOCOL>`` option to specify the desired protocol version to
use. This will default to SSL v2.3 which will negotiate the highest protocol
that both the server and your installation of OpenSSL support. The available
protocols are
``ssl2.3``, ``ssl3``, ``tls1``, ``tls1.1``, ``tls1.2``, ``tls1.3``.
(The actually available set of protocols may vary depending on your OpenSSL
installation.)

.. code-block:: bash

    # Specify the vulnerable SSL v3 protocol to talk to an outdated server:
    $ http --ssl=ssl3 https://vulnerable.example.org



SSL ciphers
-----------

You can specify the available ciphers with ``--ciphers``.
It should be a string in the
`OpenSSL cipher list format <https://www.openssl.org/docs/man1.1.0/man1/ciphers.html>`_.

.. code-block:: bash

    $ http --ciphers=ECDHE-RSA-AES128-GCM-SHA256  https://pie.dev/get

Note: these cipher strings do not change the negotiated version of SSL or TLS,
they only affect the list of available cipher suites.

To see the default cipher string, run ``http --help`` and see
the ``--ciphers`` section under SSL.



Output options
==============

By default, HTTPie only outputs the final response and the whole response
message is printed (headers as well as the body). You can control what should
be printed via several options:

=================   =====================================================
``--headers, -h``   Only the response headers are printed.
``--body, -b``      Only the response body is printed.
``--verbose, -v``   Print the whole HTTP exchange (request and response).
                    This option also enables ``--all`` (see below).
``--print, -p``     Selects parts of the HTTP exchange.
``--quiet, -q``     Don't print anything to ``stdout`` and ``stderr``.
=================   =====================================================


What parts of the HTTP exchange should be printed
-------------------------------------------------

All the other `output options`_ are under the hood just shortcuts for
the more powerful ``--print, -p``. It accepts a string of characters each
of which represents a specific part of the HTTP exchange:

==========  ==================
Character   Stands for
==========  ==================
``H``       request headers
``B``       request body
``h``       response headers
``b``       response body
==========  ==================

Print request and response headers:

.. code-block:: bash

    $ http --print=Hh PUT pie.dev/put hello=world

Verbose output
--------------

``--verbose`` can often be useful for debugging the request and generating
documentation examples:

.. code-block:: bash

    $ http --verbose PUT pie.dev/put hello=world
    PUT /put HTTP/1.1
    Accept: application/json, */*;q=0.5
    Accept-Encoding: gzip, deflate
    Content-Type: application/json
    Host: pie.dev
    User-Agent: HTTPie/0.2.7dev

    {
        "hello": "world"
    }


    HTTP/1.1 200 OK
    Connection: keep-alive
    Content-Length: 477
    Content-Type: application/json
    Date: Sun, 05 Aug 2012 00:25:23 GMT
    Server: gunicorn/0.13.4

    {
        […]
    }

Quiet output
------------

``--quiet`` redirects all output that would otherwise go to ``stdout``
and ``stderr`` to ``/dev/null`` (except for errors and warnings).
This doesn’t affect output to a file via ``--output`` or ``--download``.

.. code-block:: bash

    # There will be no output:
    $ http --quiet pie.dev/post enjoy='the silence'


Viewing intermediary requests/responses
---------------------------------------

To see all the HTTP communication, i.e. the final request/response as
well as any possible  intermediary requests/responses, use the ``--all``
option. The intermediary HTTP communication include followed redirects
(with ``--follow``), the first unauthorized request when HTTP digest
authentication is used (``--auth=digest``), etc.

.. code-block:: bash

    # Include all responses that lead to the final one:
    $ http --all --follow pie.dev/redirect/3


The intermediary requests/response are by default formatted according to
``--print, -p`` (and its shortcuts described above). If you’d like to change
that, use the ``--history-print, -P`` option. It takes the same
arguments as ``--print, -p`` but applies to the intermediary requests only.


.. code-block:: bash

    # Print the intermediary requests/responses differently than the final one:
    $ http -A digest -a foo:bar --all -p Hh -P H pie.dev/digest-auth/auth/foo/bar


Conditional body download
-------------------------

As an optimization, the response body is downloaded from the server
only if it’s part of the output. This is similar to performing a ``HEAD``
request, except that it applies to any HTTP method you use.

Let’s say that there is an API that returns the whole resource when it is
updated, but you are only interested in the response headers to see the
status code after an update:

.. code-block:: bash

    $ http --headers PATCH pie.dev/patch name='New Name'


Since we are only printing the HTTP headers here, the connection to the server
is closed as soon as all the response headers have been received.
Therefore, bandwidth and time isn’t wasted downloading the body
which you don’t care about. The response headers are downloaded always,
even if they are not part of the output


Raw request body
================

In addition to crafting structured `JSON`_ and `forms`_ requests with the
`request items`_ syntax, you can provide a raw request body that will be
sent without further processing. These two approaches for specifying request
data (i.e., structured and raw) cannot be combined.

There’re three methods for passing raw request data: piping via ``stdin``,
``--raw='data'``, and ``@/file/path``.


Redirected Input
----------------

The universal method for passing request data is through redirected ``stdin``
(standard input)—piping.

By default, ``stdin`` data is buffered and then with no further processing
used as the request body. If you provide ``Content-Length``, then the request
body is streamed without buffering. You can also use ``--chunked`` to enable
streaming via `chunked transfer encoding`_.

There are multiple useful ways to use piping:

Redirect from a file:

.. code-block:: bash

    $ http PUT pie.dev/put X-API-Token:123 < files/data.json


Or the output of another program:

.. code-block:: bash

    $ grep '401 Unauthorized' /var/log/httpd/error_log | http POST pie.dev/post


You can use ``echo`` for simple data:

.. code-block:: bash

    $ echo -n '{"name": "John"}' | http PATCH pie.dev/patch X-API-Token:123


You can also use a Bash *here string*:

.. code-block:: bash

    $ http pie.dev/post <<<'{"name": "John"}'


You can even pipe web services together using HTTPie:

.. code-block:: bash

    $ http GET https://api.github.com/repos/httpie/httpie | http POST pie.dev/post


You can use ``cat`` to enter multiline data on the terminal:

.. code-block:: bash

    $ cat | http POST pie.dev/post
    <paste>
    ^D


.. code-block:: bash

    $ cat | http POST pie.dev/post Content-Type:text/plain
    - buy milk
    - call parents
    ^D


On OS X, you can send the contents of the clipboard with ``pbpaste``:

.. code-block:: bash

    $ pbpaste | http PUT pie.dev/put


Passing data through ``stdin`` cannot be combined with data fields specified
on the command line:

.. code-block:: bash

    $ echo -n 'data' | http POST example.org more=data   # This is invalid


To prevent HTTPie from reading ``stdin`` data you can use the
``--ignore-stdin`` option.


Request data via ``--raw``
--------------------------

In a situation when piping data via ``stdin`` is not convenient (for example,
when generating API docs examples), you can specify the raw request body via
the ``--raw`` option.

.. code-block:: bash

    $ http --raw 'Hello, world!' pie.dev/post

.. code-block:: bash

    $ http --raw '{"name": "John"}' pie.dev/post


Request data from a filename
----------------------------

An alternative to redirected ``stdin`` is specifying a filename (as
``@/path/to/file``) whose content is used as if it came from ``stdin``.

It has the advantage that the ``Content-Type``
header is automatically set to the appropriate value based on the
filename extension. For example, the following request sends the
verbatim contents of that XML file with ``Content-Type: application/xml``:

.. code-block:: bash

    $ http PUT pie.dev/put @files/data.xml

File uploads are always streamed to avoid memory issues with large files.


Chunked transfer encoding
=========================

You can use the ``--chunked`` flag to instruct HTTPie to use
``Transfer-Encoding: chunked``:


.. code-block:: bash

    $ http --chunked PUT pie.dev/put hello=world

.. code-block:: bash

    $ http --chunked --multipart PUT pie.dev/put hello=world foo@files/data.xml

.. code-block:: bash

    $ http --chunked pie.dev/post @files/data.xml

.. code-block:: bash

    $ cat files/data.xml | http --chunked pie.dev/post



Terminal output
===============

HTTPie does several things by default in order to make its terminal output
easy to read.


Colors and formatting
---------------------

Syntax highlighting is applied to HTTP headers and bodies (where it makes
sense). You can choose your preferred color scheme via the ``--style`` option
if you don’t like the default one. There dozens of styles available, here are just a few special or notable ones:

====================   ========================================================================
``auto``               Follows your terminal ANSI color styles. This is the default style used by HTTPie.
``default``            Default styles of the underlying Pygments library. Not actually used by default by HTTPie.
                       You can enable it with ``--style=default``
``monokai``            A popular color scheme. Enable with ``--style=monokai``.
``fruity``             A bold, colorful scheme. Enable with ``--style=fruity``.
…                      See ``$ http --help`` for all the possible ``--style`` values.
====================   ========================================================================

Also, the following formatting is applied:

* HTTP headers are sorted by name.
* JSON data is indented, sorted by keys, and unicode escapes are converted
  to the characters they represent.

One of these options can be used to control output processing:

====================   ========================================================
``--pretty=all``       Apply both colors and formatting.
                       Default for terminal output.
``--pretty=colors``    Apply colors.
``--pretty=format``    Apply formatting.
``--pretty=none``      Disables output processing.
                       Default for redirected output.
====================   ========================================================

You can further control the applied formatting via the more granular `format options`_.


Format options
--------------

The ``--format-options`` option allows you to control how the output should be formatted when formatting is applied.
The following options are available:

+-------------------------------+---------------+------------------------------+
| Option                        | Default value | Shortcuts                    |
+===============================+===============+==============================+
| ``headers.sort``              | ``true``      | ``--sorted``, ``--unsorted`` |
+-------------------------------+---------------+------------------------------+
| ``json.format``               | ``true``      | N/A                          |
+-------------------------------+---------------+------------------------------+
| ``json.indent``               | ``4``         | N/A                          |
+--------------------+----------+---------------+------------------------------+
| ``json.sort_keys``            | ``true``      | ``--sorted``, ``--unsorted`` |
+--------------------+----------+---------------+------------------------------+

For example, this is how you would disable the default header and JSON key
sorting, and specify a custom JSON indent size:

.. code-block:: bash

    $ http --format-options headers.sort:false,json.sort_keys:false,json.indent:2 pie.dev/get

There are also two shortcuts that allow you to quickly disable and re-enable
sorting-related format options (currently it means JSON keys and headers):
``--unsorted`` and ``--sorted``.

This is something you will typically store as one of the default options in your `config`_ file.


Binary data
-----------

Binary data is suppressed for terminal output, which makes it safe to perform
requests to URLs that send back binary data. Binary data is suppressed also in
redirected, but prettified output. The connection is closed as soon as we know
that the response body is binary,

.. code-block:: bash

    $ http pie.dev/bytes/2000


You will nearly instantly see something like this:

.. code-block:: http

    HTTP/1.1 200 OK
{'fraction_non_alphanumeric': 0.1783299942591356, 'fraction_numerical': 0.009478284301664851, 'mean_word_length': 2.556120323306391, 'pattern_counts': {'":': 38, '<': 96, '<?xml version=': 0, '>': 90, 'https://': 80, 'lorem ipsum': 0, 'www.': 6, 'xml': 12}, 'pii_count': 10, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 30, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 8}}
{'dir': 'git-commits-cleaned', 'id': '6902111', 'n_tokens_mistral': 25319, 'n_tokens_neox': 23264, 'n_words': 9119}