httpie-cli/README.rst

1126 lines
32 KiB
ReStructuredText
Raw Normal View History

2012-09-21 05:43:34 +02:00
****************************************
HTTPie: a CLI, cURL-like tool for humans
****************************************
2012-08-06 22:33:40 +02:00
2012-09-21 05:43:34 +02:00
v0.3.0
2012-07-26 10:03:34 +02:00
2012-08-06 22:33:40 +02:00
HTTPie is a **command line HTTP client** whose goal is to make CLI interaction
with web services as **human-friendly** as possible. It provides a
2012-08-06 22:33:40 +02:00
simple ``http`` command that allows for sending arbitrary HTTP requests with a
simple and natural syntax, and displays colorized responses. HTTPie can be used
for **testing, debugging**, and generally **interacting** with HTTP servers.
2012-03-04 11:54:27 +01:00
2012-03-05 00:48:06 +01:00
.. image:: https://github.com/jkbr/httpie/raw/master/httpie.png
:alt: HTTPie compared to cURL
2012-08-06 22:33:40 +02:00
:width: 835
:height: 835
HTTPie is written in Python, and under the hood it uses the excellent
2012-08-07 14:49:43 +02:00
`Requests`_ for HTTP and `Pygments`_ for colorizing.
2012-08-06 22:33:40 +02:00
**Table of Contents**
.. contents::
:local:
:depth: 1
:backlinks: none
2012-02-25 13:39:38 +01:00
2012-02-25 14:42:06 +01:00
2012-08-06 22:33:40 +02:00
=============
Main Features
=============
2012-02-25 13:39:38 +01:00
2012-08-06 22:33:40 +02:00
* Expressive and intuitive syntax
* Formatted and colorized terminal output
* Built-in JSON support
* Forms and file uploads
2012-08-07 14:49:43 +02:00
* HTTPS, proxies, and authentication
2012-08-06 22:33:40 +02:00
* Arbitrary request data
* Custom headers
2012-09-21 05:43:34 +02:00
* Persistent sessions
* Python 2.6, 2.7 and 3.x support
2012-08-06 22:33:40 +02:00
* Linux, Mac OS X and Windows support
* Documentation
* Test coverage
2012-08-06 22:33:40 +02:00
============
2012-07-26 09:01:30 +02:00
Installation
============
2012-07-26 09:01:30 +02:00
The latest **stable version** of HTTPie can always be installed or updated
to via `pip`_ (prefered)
or ``easy_install``:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ pip install -U httpie
2012-07-20 22:09:53 +02:00
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ easy_install httpie
2012-03-05 00:48:06 +01:00
2012-03-05 00:48:06 +01:00
Or, you can install the **development version** directly from GitHub:
2012-08-06 22:33:40 +02:00
2012-03-05 00:48:06 +01:00
.. image:: https://secure.travis-ci.org/jkbr/httpie.png
:target: http://travis-ci.org/jkbr/httpie
:alt: Build Status of the master branch
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-02-25 13:39:38 +01:00
2012-08-06 22:33:40 +02:00
$ pip install -U https://github.com/jkbr/httpie/tarball/master
2012-08-06 22:33:40 +02:00
There are also packages available for `Ubuntu`_, `Debian`_, and possibly other
Linux distributions as well. However, they may be a significant delay between
releases and package updates.
2012-08-06 22:33:40 +02:00
2012-08-07 14:49:43 +02:00
=====
Usage
=====
2012-08-06 22:33:40 +02:00
Hello World:
.. code-block:: bash
$ http httpie.org
Synopsis:
.. code-block:: bash
$ http [flags] [METHOD] URL [ITEM [ITEM]]
See also ``http --help``.
--------
Examples
--------
2012-08-09 23:36:29 +02:00
Custom `HTTP method`_, `HTTP headers`_ and `JSON`_ data:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-08-09 23:36:29 +02:00
$ http PUT example.org X-API-Token:123 name=John
2012-08-06 22:33:40 +02:00
2012-08-09 23:36:29 +02:00
Submitting `forms`_:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-08-09 23:36:29 +02:00
$ http -f POST example.org hello=World
2012-08-06 22:33:40 +02:00
2012-08-09 23:36:29 +02:00
See the request that is being sent using on of the `output options`_:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-08-09 23:36:29 +02:00
$ http -v example.org
2012-08-06 22:33:40 +02:00
2012-08-09 23:36:29 +02:00
Use `Github API`_ to post a comment on an issue with `authentication`_:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http -a USERNAME POST https://api.github.com/repos/jkbr/httpie/issues/83/comments body='HTTPie is awesome!'
2012-08-09 23:36:29 +02:00
Upload a file using `redirected input`_:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http example.org < file.json
2012-08-09 23:36:29 +02:00
Download a file and save it via `redirected output`_:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http example.org/file > file
2012-08-09 23:36:29 +02:00
--------
*What follows is a detailed documentation. It covers the command syntax,
advances usage, and also features additional examples.*
2012-08-06 22:33:40 +02:00
============
HTTP Method
============
The name of the HTTP method comes right before the URL argument:
.. code-block:: bash
$ http DELETE example.org/todos/7
2012-08-09 23:36:29 +02:00
Which looks similar to the actual ``Request-Line`` that is sent:
2012-08-06 22:33:40 +02:00
.. code-block:: http
DELETE /todos/7 HTTP/1.1
2012-03-05 00:48:06 +01:00
2012-08-06 22:33:40 +02:00
When the ``METHOD`` argument is **omitted** from the command, HTTPie defaults to
2012-08-07 14:49:43 +02:00
either ``GET`` (with no request data) or ``POST`` (with request data).
2012-08-06 22:33:40 +02:00
===========
Request URL
===========
The only information HTTPie needs to perform a request is a URL.
The default scheme is, somewhat unsurprisingly, ``http://``,
and can be omitted from the argument ``http example.org`` works just fine.
If find yourself manually constructing URLs with **querystring parameters**
on the terminal, you may appreciate the ``param==value`` syntax for appending
URL parameters so that you don't have to worry about escaping the ``&``
separators. To search for ``HTTPie`` on Google Images you could use this
command:
.. code-block:: bash
$ http GET www.google.com search==HTTPie tbm==isch
.. code-block:: http
GET /?search=HTTPie&tbm=isch HTTP/1.1
=============
Request Items
=============
There are five 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 ``==``.
+-----------------------+-----------------------------------------------------+
| Item Type | Description |
+=======================+=====================================================+
| HTTP Headers | Arbitrary HTTP header, e.g. ``X-API-Token:123``. |
| ``Name:Value`` | |
2012-07-26 09:01:30 +02:00
+-----------------------+-----------------------------------------------------+
2012-08-06 22:33:40 +02:00
| URL parameters | Appends the given name/value pair as a query |
| ``name==value`` | string parameter to the URL. |
| | The ``==`` separator is used |
2012-07-26 09:01:30 +02:00
+-----------------------+-----------------------------------------------------+
2012-08-06 22:33:40 +02:00
| Data Fields | Request data fields to be serialized as a JSON |
| ``field=value`` | object (default), or to be form encoded (``--form`` |
| | / ``-f``). |
2012-07-26 09:01:30 +02:00
+-----------------------+-----------------------------------------------------+
2012-08-06 22:33:40 +02:00
| Raw JSON fields | Useful when sending JSON and one or |
2012-07-26 09:01:30 +02:00
| ``field:=json`` | more fields need to be a ``Boolean``, ``Number``, |
2012-08-06 22:33:40 +02:00
| | nested ``Object``, or an ``Array``, e.g., |
| | ``meals:='["ham","spam"]'`` or ``pies:=[1,2,3]`` |
| | (note the quotes). |
2012-07-26 09:01:30 +02:00
+-----------------------+-----------------------------------------------------+
2012-08-06 22:33:40 +02:00
| Files | Only available with ``-f`` / ``--form``. |
| ``field@/dir/file`` | For example ``screenshot@~/Pictures/img.png``. |
2012-07-26 09:01:30 +02:00
| | The presence of a file field results |
2012-08-06 22:33:40 +02:00
| | in a ``multipart/form-data`` request. |
2012-07-26 09:01:30 +02:00
+-----------------------+-----------------------------------------------------+
2012-08-06 22:33:40 +02:00
You can use ``\`` to escape characters that shouldn't be used as separators
(or parts thereof). e.g., ``foo\==bar`` will become a data key/value
pair (``foo=`` and ``bar``) instead of a URL parameter.
2012-07-26 09:01:30 +02:00
2012-08-09 23:36:29 +02:00
Note that data fields aren't the only way to specify request data,
2012-08-06 22:33:40 +02:00
`redirected input`_ allows passing arbitrary data to be sent with the request.
2012-03-14 22:55:09 +01:00
2012-08-06 22:33:40 +02:00
====
JSON
====
JSON is the *lingua franca* of modern web services and it is also the
**implicit content type** HTTPie by default uses:
2012-08-06 22:33:40 +02:00
If your command includes some data items, they are serialized as a JSON
object by default. HTTPie also automatically sets the following headers,
both of which can be overwritten:
2012-03-05 00:48:06 +01:00
2012-08-06 22:33:40 +02:00
================ =======================================
``Content-Type`` ``application/json; charset=utf-8``
``Accept`` ``application/json``
================ =======================================
2012-03-05 00:48:06 +01:00
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
2012-08-06 22:33:40 +02:00
``http url Accept:application/json``).
2012-08-06 22:33:40 +02:00
Simple example:
2012-02-25 13:47:23 +01:00
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http PUT example.org name=John email=john@example.org
.. code-block:: http
PUT / HTTP/1.1
Accept: application/json
Accept-Encoding: identity, deflate, compress, gzip
2012-02-25 13:47:23 +01:00
Content-Type: application/json; charset=utf-8
2012-08-06 22:33:40 +02:00
Host: example.org
User-Agent: HTTPie/0.2.7dev
{
"name": "John",
"email": "john@example.org"
}
Non-string fields use the ``:=`` separator, which allows you to embed raw JSON
into the resulting object:
.. code-block:: bash
$ http PUT api.example.com/person/1 name=John age:=29 married:=false hobbies:='["http", "pies"]'
2012-02-25 13:47:23 +01:00
2012-02-27 11:54:41 +01:00
2012-08-06 22:33:40 +02:00
.. code-block:: http
2012-08-06 22:33:40 +02:00
PUT /person/1 HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: api.example.com
User-Agent: HTTPie/0.2.7dev
{
"age": 29,
"hobbies": [
"http",
"pies"
],
"married": false,
"name": "John"
}
2012-08-09 23:36:29 +02:00
Send JSON data stored in a file (see `redirected input`_ for more examples):
.. code-block:: bash
$ http POST api.example.com/person/1 < person.json
2012-08-06 22:33:40 +02:00
=====
Forms
=====
Submitting forms is very similar to sending `JSON`_ requests. Often the only
difference is in adding the ``--form`` / ``-f`` option, which ensures that
2012-08-09 23:36:29 +02:00
data fields are serialized as, and ``Content-Type`` is set to,
2012-08-06 22:33:40 +02:00
``application/x-www-form-urlencoded; charset=utf-8``.
It is possible to make form data the implicit content type via the `config`_
file.
2012-08-09 23:36:29 +02:00
2012-08-06 22:33:40 +02:00
-------------
Regular Forms
-------------
.. code-block:: bash
$ http --form POST api.example.org/person/1 name='John Smith' email=john@example.org
.. code-block:: http
POST /person/1 HTTP/1.1
User-Agent: HTTPie/0.2.7dev
2012-03-05 00:48:06 +01:00
Content-Type: application/x-www-form-urlencoded; charset=utf-8
2012-08-06 22:33:40 +02:00
name=John+Smith&email=john%40example.org
-----------------
File Upload Forms
-----------------
2012-08-09 23:36:29 +02:00
If one or more file fields is present, the serialization and content type is
2012-08-06 22:33:40 +02:00
``multipart/form-data``:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-08-06 22:33:40 +02:00
$ http -f POST example.com/jobs name='John Smith' cv@~/Documents/cv.pdf
2012-08-06 22:33:40 +02:00
The request above is the same as if the following HTML form were
submitted:
.. code-block:: html
2012-03-14 22:55:09 +01:00
<form enctype="multipart/form-data" method="post" action="http://example.com/jobs">
<input type="text" name="name" />
<input type="file" name="cv" />
</form>
2012-08-06 22:33:40 +02:00
============
HTTP Headers
============
To set custom headers you can use the ``Header:Value`` notation:
.. code-block:: bash
$ http example.org User-Agent:Bacon/1.0 Cookie:valued-visitor=yes X-Foo:Bar Referer:http://httpie.org/
.. code-block:: http
GET / HTTP/1.1
Accept: */*
Accept-Encoding: identity, deflate, compress, gzip
Cookie: valued-visitor=yes
Host: example.org
Referer: http://httpie.org/
User-Agent: Bacon/1.0
X-Foo: Bar
2012-08-09 23:36:29 +02:00
There are a couple of default headers that HTTPie sets:
2012-08-06 22:33:40 +02:00
.. code-block:: http
GET / HTTP/1.1
Accept: */*
Accept-Encoding: identity, deflate, compress, gzip
User-Agent: HTTPie/<version>
Host: <taken-from-URL>
2012-08-09 23:36:29 +02:00
Any of the default headers can be overwritten.
2012-08-07 14:49:43 +02:00
==============
Authentication
==============
2012-08-06 22:33:40 +02:00
2012-08-07 14:49:43 +02:00
The currently supported authentication schemes are Basic and Digest (more to
come). There are two flags that control authentication:
2012-08-06 22:33:40 +02:00
=================== ======================================================
``--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 a an empty password, pass ``username:``.
``--auth-type`` Specify the auth mechanism. Possible values are
``basic`` and ``digest``. The default value is
``basic`` so it can often be omitted.
=================== ======================================================
2012-08-07 14:49:43 +02:00
Authorization information from ``.netrc`` is respected as well.
2012-08-06 22:33:40 +02:00
Basic auth:
2012-02-25 13:39:38 +01:00
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-02-25 13:47:23 +01:00
2012-08-06 22:33:40 +02:00
$ http -a username:password example.org
2012-06-25 14:50:49 +02:00
2012-08-06 22:33:40 +02:00
Digest auth:
2012-06-25 14:50:49 +02:00
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-06-25 14:50:49 +02:00
2012-08-06 22:33:40 +02:00
$ http --auth-type=digest -a username:password example.org
2012-06-25 14:50:49 +02:00
2012-08-06 22:33:40 +02:00
With password prompt:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-08-06 22:33:40 +02:00
$ http -a username example.org
2012-08-07 14:49:43 +02:00
=======
Proxies
=======
You can specify proxies to be used through the ``--proxy`` argument:
.. code-block:: bash
http --proxy=http:10.10.1.10:3128 --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
You can also configure proxies by environment variables ``HTTP_PROXY`` and
``HTTPS_PROXY``, and the underlying Requests library will pick them up as well.
2012-08-07 15:01:04 +02:00
If you want to disable proxies configured through the environment variables for
2012-08-07 14:49:43 +02:00
certain hosts, you can specify them in ``NO_PROXY``.
In your ``~/.bash_profile``:
.. code-block:: bash
export HTTP_PROXY=10.10.1.10:3128
export HTTPS_PROXY=10.10.1.10:1080
export NO_PROXY=localhost,example.com
2012-08-07 15:25:24 +02:00
=====
HTTPS
=====
2012-08-09 23:36:29 +02:00
To skip the host's SSL certificate verification, you can pass ``--verify=no``
(default is ``yes``). You can also use ``--verify`` to set a custom CA bundle
path. The path can also be configured via the environment variable
``REQUESTS_CA_BUNDLE``.
2012-08-07 15:25:24 +02:00
2012-08-06 22:33:40 +02:00
==============
Output Options
==============
2012-08-06 22:33:40 +02:00
By default, HTTPie outputs the whole response message (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).
``--print, -p`` Selects parts of the HTTP exchange.
================= =====================================================
``--verbose`` can often be useful for debugging the request and generating
documentation examples:
.. code-block:: bash
$ http --verbose PUT httpbin.org/put hello=world
PUT /put HTTP/1.1
Accept: application/json
Accept-Encoding: identity, deflate, compress, gzip
Content-Type: application/json; charset=utf-8
Host: httpbin.org
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
{
[…]
}
All the other options are just a shortcut for ``--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.
========== ==================
2012-08-09 23:36:29 +02:00
Print request and response headers:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http --print=Hh PUT httpbin.org/put hello=world
-------------------------
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
2012-08-09 23:36:29 +02:00
status code after an update:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http --headers PATCH example.org/Really-Huge-Resource name='New Name'
2012-08-09 23:36:29 +02:00
Since we are only printing the HTTP headers here, the connection to the server
2012-08-06 22:33:40 +02:00
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
================
Redirected Input
================
**A universal method for passing request data is through redirected** ``stdin``
(standard input). Such data is buffered and then with no further processing
used as the request body. There are multiple useful ways to use piping:
Redirect from a file:
.. code-block:: bash
$ http PUT example.com/person/1 X-API-Token:123 < person.json
Or the output of another program:
.. code-block:: bash
$ grep /var/log/httpd/error_log '401 Unauthorized' | http POST example.org/intruders
You can use ``echo`` for simple data:
.. code-block:: bash
$ echo '{"name": "John"}' | http PATCH example.com/person/1 X-API-Token:123
You can even pipe web services together using HTTPie:
.. code-block:: bash
$ http GET https://api.github.com/repos/jkbr/httpie | http POST httpbin.org/post
You can use ``cat`` to enter multiline data on the terminal:
.. code-block:: bash
$ cat | http POST example.com
2012-08-06 22:33:40 +02:00
<paste>
^D
.. code-block:: bash
$ cat | http POST example.com/todos Content-Type:text/plain
2012-08-06 22:33:40 +02:00
- buy milk
- call parents
^D
On OS X, you can send the contents of the clipboard with ``pbpaste``:
.. code-block:: bash
$ pbpaste | http PUT example.com
Passing data through ``stdin`` cannot be combined with data fields specified
on the command line.
-------------------------
Body 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``
2012-08-09 23:36:29 +02:00
**header is automatically set** to the appropriate value based on the
2012-08-06 22:33:40 +02:00
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 httpbin.org/put @/data/file.xml
=================
Terminal Output
=================
2012-08-09 23:36:29 +02:00
HTTPie does several things by default in order to make its terminal output
easy to read.
2012-08-06 22:33:40 +02:00
---------------------
Colors and Formatting
---------------------
Syntax highlighting is applied to HTTP headers and bodies (where it makes
sense). You can choose your prefered color scheme via the ``--style`` option
2012-08-09 23:36:29 +02:00
if you don't like the default one (see ``$ http --help`` for the possible
values).
Also, the following formatting is applied:
2012-08-06 22:33:40 +02:00
* 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:
2012-08-06 22:33:40 +02:00
==================== ========================================================
``--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.
==================== ========================================================
2012-08-06 22:33:40 +02:00
-----------
Binary data
-----------
Binary data is suppressed for terminal output, which makes it safe to perform
2012-08-09 23:36:29 +02:00
requests to URLs that send back binary data. Binary data is suppressed also in
2012-08-06 22:33:40 +02:00
redirected, but prettified output. The connection is closed as soon as we know
that the response body is binary,
.. code-block:: bash
2012-08-09 23:36:29 +02:00
http example.org/Movie.mov
2012-08-06 22:33:40 +02:00
2012-08-09 23:36:29 +02:00
You will nearly instantly see something like this:
2012-08-06 22:33:40 +02:00
.. code-block:: http
HTTP/1.1 200 OK
Accept-Ranges: bytes
Content-Encoding: gzip
Content-Type: video/quicktime
Transfer-Encoding: chunked
+-----------------------------------------+
| NOTE: binary data not shown in terminal |
+-----------------------------------------+
=================
Redirected Output
=================
HTTPie uses **different defaults** for redirected output than for
`terminal output`_:
* Formatting and colors aren't applied (unless ``--pretty`` is specified).
2012-08-06 22:33:40 +02:00
* Only the response body is printed (unless one of the `output options`_ is set).
* Also, binary data isn't suppressed.
The reason is to make piping HTTPie's output to another programs and
downloading files work with no extra flags. Most of the time, only the raw
response body is of an interest when the output is redirected.
Download a file:
.. code-block:: bash
$ http example.org/Movie.mov > Movie.mov
Download an image of Octocat, resize it using ImageMagick, upload it elsewhere:
.. code-block:: bash
$ http octodex.github.com/images/original.jpg | convert - -resize 25% - | http example.org/Octocats
2012-08-09 23:36:29 +02:00
Force colorizing and formatting, and show both the request and the response in
2012-08-06 22:33:40 +02:00
``less`` pager:
.. code-block:: bash
$ http --pretty=all --verbose example.org | less -R
2012-08-06 22:33:40 +02:00
2012-08-09 23:36:29 +02:00
The ``-R`` flag tells ``less`` to interpret color escape sequences included
HTTPie`s output.
2012-08-06 22:33:40 +02:00
==================
Streamed Responses
==================
Responses are downloaded and printed in chunks, which allows for streaming
and large file downloads without using too much RAM. However, when
2012-08-09 23:36:29 +02:00
`colors and formatting`_ is applied, the whole response is buffered and only
2012-08-06 22:33:40 +02:00
then processed at once.
You can use the ``--stream, -S`` flag to make two things happen:
1. The output is flushed in **much smaller chunks** without any buffering,
which makes HTTPie behave kind of like ``tail -f`` for URLs.
2. Streaming becomes enabled even when the output is prettified: It will be
applied to **each line** of the response and flushed immediately. This makes
2012-08-09 23:36:29 +02:00
it possible to have a nice output for long-lived requests, such as one
2012-08-06 22:33:40 +02:00
to the Twitter streaming API.
Prettified streamed response:
.. code-block:: bash
$ http --stream -f -a YOUR-TWITTER-NAME https://stream.twitter.com/1/statuses/filter.json track='Justin Bieber'
2012-08-09 23:36:29 +02:00
Streamed output by small chunks alá ``tail -f``:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
# Send each new tweet (JSON object) mentioning "Apple" to another
# server as soon as it arrives from the Twitter streaming API:
$ http --stream -f -a YOUR-TWITTER-NAME https://stream.twitter.com/1/statuses/filter.json track=Apple \
| while read tweet; do echo "$tweet" | http POST example.org/tweets ; done
========
Sessions
========
2012-09-21 05:43:34 +02:00
By default, every request is completely independent of the previous ones.
HTTPie supports persistent sessions, where custom headers, authorization,
and cookies (manually specified or sent by the server) persist between
requests. Sessions are named and host-bound.
Create a new session named ``user1``:
.. code-block:: bash
2012-09-21 05:43:34 +02:00
$ http --session=user1 -a user1:password example.org X-Foo:Bar
Now you can refer to the session by its name:
.. code-block:: bash
2012-09-21 05:43:34 +02:00
$ http --session=user1 example.org
2012-09-21 05:43:34 +02:00
To create or reuse a different session, simple specify a different name:
.. code-block:: bash
2012-09-21 05:43:34 +02:00
$ http --session=user2 -a user2:password example.org X-Bar:Foo
To use a session without updating it from the request/response exchange
once it is created, specify the session name via
``--session-read-only=SESSION_NAME`` instead.
2012-09-21 05:43:34 +02:00
Sessions are stored as JSON files in ``~/.httpie/sessions/<host>/<name>.json``
(``%APPDATA%\httpie\sessions\<host>\<name>.json`` on Windows).
See also `config`_.
======
Config
======
2012-09-21 05:43:34 +02:00
HTTPie uses a simple configuration file that contains a JSON object with the
following keys:
========================= =================================================
``__version__`` HTTPie automatically sets this to its version.
Do not change.
``implicit_content_type`` A ``String`` specifying the implicit content type
for request data. The default value for this
option is ``json`` and can be changed to
``form``.
``default_options`` An ``Array`` (by default empty) of options
that should be applied to every request.
========================= =================================================
The default location is ``~/.httpie/config.json``
(``%APPDATA%\httpie\config.json`` on Windows).
The config directory location can be changed by setting the
``HTTPIE_CONFIG_DIR`` environment variable.
2012-08-06 22:33:40 +02:00
=========
Scripting
=========
When using HTTPie from **shell scripts**, it can be handy to set the
``--check-status`` flag. It instructs HTTPie to exit with an error if the
HTTP status is one of ``3xx``, ``4xx``, or ``5xx``. The exit status will
2012-09-07 11:58:39 +02:00
be ``3`` (unless ``--follow`` is set), ``4``, or ``5``,
respectively. Also, the ``--timeout`` option allows to overwrite the default
30s timeout:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
#!/bin/bash
if http --timeout=2.5 --check-status HEAD example.org/health &> /dev/null; then
echo 'OK!'
else
case $? in
2) echo 'Request timed out!' ;;
2012-08-06 22:33:40 +02:00
3) echo 'Unexpected HTTP 3xx Redirection!' ;;
4) echo 'HTTP 4xx Client Error!' ;;
5) echo 'HTTP 5xx Server Error!' ;;
*) echo 'Other Error!' ;;
esac
fi
2012-08-06 22:33:40 +02:00
================
Interface Design
================
The syntax of the command arguments closely corresponds to the actual HTTP
requests sent over the wire. It has the advantage that it's easy to remember
and read. It is often possible to translate an HTTP request to an HTTPie
argument list just by inlining the request elements. For example, compare this
HTTP request:
.. code-block:: http
POST /collection HTTP/1.1
X-API-Key: 123
User-Agent: Bacon/1.0
Content-Type: application/x-www-form-urlencoded
name=value&name2=value2
with the HTTPie command that sends it:
2012-03-04 13:33:18 +01:00
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http -f POST example.org/collection \
X-API-Key:123 \
User-Agent:Bacon/1.0 \
name=value \
name2=value2
Notice that both the order of elements and the syntax is very similar,
and that only a small portion of the command is used to control HTTPie and
doesn't directly correspond to any part of the request (here it's only ``-f``
asking HTTPie to send a form request).
The two modes, ``--pretty=all`` (default for terminal) and ``--pretty=none``
2012-08-06 22:33:40 +02:00
(default for redirected output), allow for both user-friendly interactive use
and usage from scripts, where HTTPie serves as a generic HTTP client.
2012-08-09 23:36:29 +02:00
As HTTPie is still under heavy development, the existing command line
syntax and some of the ``--OPTIONS`` may change slightly before
HTTPie reaches its final version ``1.0``. All changes are recorded in the
`changelog`_.
2012-08-06 22:33:40 +02:00
==========
2012-06-15 17:13:40 +02:00
Contribute
2012-07-26 09:01:30 +02:00
==========
2012-07-26 09:01:30 +02:00
Bug reports and code and documentation patches are greatly appretiated. You can
also help by using the development version of HTTPie and reporting any bugs you
might encounter.
2012-07-26 09:01:30 +02:00
Before working on a new feature or a bug, please browse the `existing issues`_
2012-08-06 22:33:40 +02:00
to see whether it has been previously discussed. If the change in question
is a bigger one, it's always good to discuss before your starting working on
it.
2012-06-15 17:13:40 +02:00
2012-07-26 09:01:30 +02:00
Then fork and clone `the repository`_.
2012-06-15 17:13:40 +02:00
2012-08-06 22:33:40 +02:00
It's very useful to point the ``http`` command to your local branch during
development. To do so, install HTTPie with ``pip`` in editable mode:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-08-06 22:33:40 +02:00
$ pip install --upgrade --force-reinstall --editable .
2012-08-06 22:33:40 +02:00
Please run the existing suite of tests before a pull request is submitted:
.. code-block:: bash
2012-06-15 17:13:40 +02:00
python setup.py test
2012-08-06 22:33:40 +02:00
2012-07-26 09:01:30 +02:00
`Tox`_ can also be used to conveniently run tests in all of the
`supported Python environments`_:
2012-08-07 14:49:43 +02:00
.. code-block:: bash
2012-06-15 17:13:40 +02:00
2012-06-15 17:32:45 +02:00
# Install tox
2012-06-15 17:13:40 +02:00
pip install tox
2012-06-15 17:32:45 +02:00
# Run tests
tox
2012-08-06 22:33:40 +02:00
Don't forget to add yourself to `AUTHORS.rst`_.
2012-07-30 12:10:19 +02:00
2012-07-26 09:01:30 +02:00
2012-08-06 22:33:40 +02:00
=======
Authors
=======
`Jakub Roztocil`_ (`@jakubroztocil`_) created HTTPie and `these fine people`_
have contributed.
2012-08-06 22:33:40 +02:00
=======
Licence
=======
Please see `LICENSE`_.
=========
2012-03-05 00:48:06 +01:00
Changelog
2012-07-26 09:01:30 +02:00
=========
2012-03-04 13:33:18 +01:00
2012-08-09 23:36:29 +02:00
*You can click a version name to see a diff with the previous one.*
2012-09-21 05:43:34 +02:00
* `0.3.0`_ (2012-09-21)
* Allow output redirection on Windows.
2012-09-21 05:43:34 +02:00
* Added configuration file.
* Added persistent session support.
2012-09-07 11:58:39 +02:00
* Renamed ``--allow-redirects`` to ``--follow``.
* Improved the usability of ``http --help``.
* Fixed installation on Windows with Python 3.
* Fixed colorized output on Windows with Python 3.
2012-08-12 06:02:13 +02:00
* CRLF HTTP header field separation in the output.
* Added exit status code ``2`` for timed-out requests.
* Added the option to separate colorizing and formatting
(``--pretty=all``, ``--pretty=colors`` and ``--pretty=format``).
``--ugly`` has bee removed in favor of ``--pretty=none``.
2012-08-07 00:12:47 +02:00
* `0.2.7`_ (2012-08-07)
2012-08-07 00:07:04 +02:00
* Compatibility with Requests 0.13.6.
* Streamed terminal output. ``--stream`` / ``-S`` can be used to enable
streaming also with ``--pretty`` and to ensure a more frequent output
flushing.
* Support for efficient large file downloads.
* Sort headers by name (unless ``--pretty=none``).
* Response body is fetched only when needed (e.g., not with ``--headers``).
2012-08-01 23:51:30 +02:00
* Improved content type matching.
2012-07-30 14:23:22 +02:00
* Updated Solarized color scheme.
* Windows: Added ``--output FILE`` to store output into a file
2012-08-06 22:33:40 +02:00
(piping results in corrupted data on Windows).
* Proper handling of binary requests and responses.
* Fixed printing of ``multipart/form-data`` requests.
* Renamed ``--traceback`` to ``--debug``.
2012-07-26 09:01:30 +02:00
* `0.2.6`_ (2012-07-26)
* The short option for ``--headers`` is now ``-h`` (``-t`` has been
removed, for usage use ``--help``).
* Form data and URL parameters can have multiple fields with the same name
2012-07-24 17:22:04 +02:00
(e.g.,``http -f url a=1 a=2``).
2012-07-26 09:01:30 +02:00
* Added ``--check-status`` to exit with an error on HTTP 3xx, 4xx and
5xx (3, 4, and 5, respectively).
* If the output is piped to another program or redirected to a file,
2012-07-26 09:01:30 +02:00
the default behaviour is to only print the response body.
2012-07-26 00:26:23 +02:00
(It can still be overwritten via the ``--print`` flag.)
* Improved highlighting of HTTP headers.
2012-07-26 09:01:30 +02:00
* Added query string parameters (``param==value``).
2012-07-17 04:20:37 +02:00
* Added support for terminal colors under Windows.
2012-07-26 09:01:30 +02:00
* `0.2.5`_ (2012-07-17)
2012-07-17 07:01:30 +02:00
* Unicode characters in prettified JSON now don't get escaped for
improved readability.
2012-07-17 00:05:09 +02:00
* --auth now prompts for a password if only a username provided.
2012-07-17 07:01:30 +02:00
* Added support for request payloads from a file path with automatic
``Content-Type`` (``http URL @/path``).
2012-07-26 00:26:23 +02:00
* Fixed missing query string when displaying the request headers via
2012-07-17 07:01:30 +02:00
``--verbose``.
* Fixed Content-Type for requests with no data.
2012-07-26 09:01:30 +02:00
* `0.2.2`_ (2012-06-24)
2012-07-17 07:01:30 +02:00
* The ``METHOD`` positional argument can now be omitted (defaults to
``GET``, or to ``POST`` with data).
2012-06-24 03:43:08 +02:00
* Fixed --verbose --form.
2012-07-26 09:01:30 +02:00
* Added support for `Tox`_.
* `0.2.1`_ (2012-06-13)
2012-06-13 16:01:23 +02:00
* Added compatibility with ``requests-0.12.1``.
2012-07-17 07:01:30 +02:00
* Dropped custom JSON and HTTP lexers in favor of the ones newly included
in ``pygments-1.5``.
2012-07-26 09:01:30 +02:00
* `0.2.0`_ (2012-04-25)
2012-04-25 02:10:58 +02:00
* Added Python 3 support.
2012-07-17 07:01:30 +02:00
* Added the ability to print the HTTP request as well as the response
(see ``--print`` and ``--verbose``).
2012-04-25 02:10:58 +02:00
* Added support for Digest authentication.
2012-07-17 07:01:30 +02:00
* Added file upload support
(``http -f POST file_field_name@/path/to/file``).
2012-04-25 02:10:58 +02:00
* Improved syntax highlighting for JSON.
* Added support for field name escaping.
* Many bug fixes.
2012-07-26 09:01:30 +02:00
* `0.1.6`_ (2012-03-04)
.. _Requests: http://python-requests.org
.. _Pygments: http://pygments.org/
.. _pip: http://www.pip-installer.org/en/latest/index.html
.. _Tox: http://tox.testrun.org
2012-08-06 22:33:40 +02:00
.. _Github API: http://developer.github.com/v3/issues/comments/#create-a-comment
2012-07-26 09:01:30 +02:00
.. _supported Python environments: https://github.com/jkbr/httpie/blob/master/tox.ini
.. _Ubuntu: http://packages.ubuntu.com/httpie
.. _Debian: http://packages.debian.org/httpie
.. _the repository: https://github.com/jkbr/httpie
.. _these fine people: https://github.com/jkbr/httpie/contributors
2012-07-26 09:01:30 +02:00
.. _Jakub Roztocil: http://roztocil.name
.. _@jakubroztocil: https://twitter.com/jakubroztocil
2012-07-26 09:01:30 +02:00
.. _existing issues: https://github.com/jkbr/httpie/issues?state=open
.. _0.1.6: https://github.com/jkbr/httpie/compare/0.1.4...0.1.6
.. _0.2.0: https://github.com/jkbr/httpie/compare/0.1.6...0.2.0
.. _0.2.1: https://github.com/jkbr/httpie/compare/0.2.0...0.2.1
.. _0.2.2: https://github.com/jkbr/httpie/compare/0.2.1...0.2.2
.. _0.2.5: https://github.com/jkbr/httpie/compare/0.2.2...0.2.5
.. _0.2.6: https://github.com/jkbr/httpie/compare/0.2.5...0.2.6
2012-08-07 00:12:47 +02:00
.. _0.2.7: https://github.com/jkbr/httpie/compare/0.2.5...0.2.7
2012-09-21 05:43:34 +02:00
.. _0.3.0: https://github.com/jkbr/httpie/compare/0.2.7...0.3.0
.. _stable version: https://github.com/jkbr/httpie/tree/0.3.0#readme
.. _AUTHORS.rst: https://github.com/jkbr/httpie/blob/master/AUTHORS.rst
2012-08-06 22:33:40 +02:00
.. _LICENSE: https://github.com/jkbr/httpie/blob/master/LICENSE