httpie-cli/README.rst

1454 lines
40 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
2016-02-28 09:19:18 +01:00
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. It provides a simple ``http`` command that allows for sending
2014-03-25 00:03:59 +01:00
arbitrary HTTP requests using a simple and natural syntax, and displays
2015-02-15 12:53:57 +01:00
colorized output. HTTPie can be used for **testing, debugging**, and
2014-03-25 00:03:59 +01:00
generally **interacting** with HTTP servers.
2012-08-06 22:33:40 +02:00
2012-03-04 11:54:27 +01:00
2015-07-03 03:40:38 +02:00
.. image:: https://raw.githubusercontent.com/jkbrzt/httpie/master/httpie.png
2012-03-05 00:48:06 +01:00
:alt: HTTPie compared to cURL
2015-02-15 00:42:41 +01:00
:width: 679
:height: 781
:align: center
2012-08-06 22:33:40 +02:00
2012-08-06 22:33:40 +02:00
HTTPie is written in Python, and under the hood it uses the excellent
2012-09-24 05:59:52 +02:00
`Requests`_ and `Pygments`_ libraries.
2012-08-06 22:33:40 +02:00
2015-02-15 12:53:57 +01:00
-----
2016-03-01 09:50:30 +01:00
|pypi| |unix_build| |windows_build| |coverage| |gitter|
2015-02-15 12:53:57 +01:00
-----
2012-08-06 22:33:40 +02:00
.. contents::
:local:
:depth: 1
:backlinks: none
2012-02-25 13:39:38 +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
* Wget-like downloads
* Python 2.6, 2.7 and 3.x support
2012-08-06 22:33:40 +02:00
* Linux, Mac OS X and Windows support
2014-06-28 20:44:40 +02:00
* Plugins
2012-08-06 22:33:40 +02:00
* Documentation
* Test coverage
2012-08-06 22:33:40 +02:00
============
2012-07-26 09:01:30 +02:00
Installation
============
On **Mac OS X**, HTTPie can be installed via `Homebrew <http://brew.sh/>`_
(recommended):
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ brew install httpie
2014-06-28 13:26:48 +02:00
A MacPorts *port* is also available:
.. code-block:: bash
$ port install httpie
2015-02-15 12:53:57 +01:00
Most **Linux** distributions provide a package that can be installed using the
2015-02-24 16:50:02 +01:00
system package manager, e.g.:
2015-02-15 12:53:57 +01:00
.. code-block:: bash
# Debian-based distributions such as Ubuntu:
$ apt-get install httpie
# RPM-based distributions:
$ yum install httpie
2012-07-20 22:09:53 +02:00
2014-06-28 13:26:48 +02:00
A **universal installation method** (that works on **Windows**, Mac OS X, Linux, …,
and provides the latest version) is to use `pip`_:
2012-09-24 05:59:52 +02:00
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2014-06-24 17:27:01 +02:00
2015-02-15 12:53:57 +01:00
# Make sure we have an up-to-date version of pip and setuptools:
$ pip install --upgrade pip setuptools
2012-08-06 22:33:40 +02:00
2015-02-15 12:53:57 +01:00
$ pip install --upgrade httpie
2012-03-05 00:48:06 +01:00
2015-02-15 12:53:57 +01:00
(If ``pip`` installation fails for some reason, you can try
``easy_install httpie`` as a fallback.)
2014-03-04 18:36:22 +01:00
-------------------
Development version
-------------------
2012-03-05 00:48:06 +01:00
The **latest development version** can be installed directly from GitHub:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2012-02-25 13:39:38 +01:00
2014-06-28 13:26:48 +02:00
# Mac OS X via Homebrew
$ brew install httpie --HEAD
# Universal
2016-02-28 09:20:19 +01:00
$ pip install --upgrade https://github.com/jkbrzt/httpie/archive/master.tar.gz
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-09-24 05:59:52 +02:00
See the request that is being sent using one 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
2013-04-11 09:00:41 +02:00
Use `Github API`_ to post a comment on an
2015-07-03 03:40:38 +02:00
`issue <https://github.com/jkbrzt/httpie/issues/83>`_
2013-04-11 09:00:41 +02:00
with `authentication`_:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2015-07-03 03:40:38 +02:00
$ http -a USERNAME POST https://api.github.com/repos/jkbrzt/httpie/issues/83/comments body='HTTPie is awesome!'
2012-08-06 22:33:40 +02:00
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
Download a file ``wget`` style:
.. code-block:: bash
$ http --download example.org/file
2012-09-24 05:59:52 +02:00
Use named `sessions`_ to make certain aspects or the communication persistent
between requests to the same host:
.. code-block:: bash
$ http --session=logged-in -a username:password httpbin.org/get API-Key:123
$ http --session=logged-in httpbin.org/headers
2013-05-20 15:31:02 +02:00
Set a custom ``Host`` header to work around missing DNS records:
.. code-block:: bash
$ http localhost:8000 Host:example.com
2012-09-24 05:59:52 +02:00
..
2012-08-09 23:36:29 +02:00
--------
*What follows is a detailed documentation. It covers the command syntax,
2012-09-24 05:59:52 +02:00
advanced usage, and also features additional examples.*
2012-08-09 23:36:29 +02:00
===========
2012-08-06 22:33:40 +02:00
HTTP Method
===========
2012-08-06 22:33:40 +02:00
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.
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
2013-10-09 20:34:22 +02:00
2013-10-09 20:37:05 +02:00
2013-10-09 20:34:22 +02:00
.. code-block:: http
2013-10-09 20:37:05 +02:00
GET /foo HTTP/1.1
2013-10-09 20:36:01 +02:00
Host: localhost
2013-10-09 20:34:22 +02:00
2013-10-09 20:37:05 +02:00
2013-10-09 20:34:22 +02:00
.. code-block:: bash
$ http :3000/bar
2013-10-09 20:37:05 +02:00
2013-10-09 20:34:22 +02:00
.. code-block:: http
2013-10-09 20:37:05 +02:00
GET /bar HTTP/1.1
2013-10-09 20:36:01 +02:00
Host: localhost:3000
2013-10-09 20:34:22 +02:00
2014-01-25 15:04:15 +01:00
.. code-block:: bash
$ http :
.. code-block:: http
GET / HTTP/1.1
Host: localhost
2015-03-10 09:05:13 +01:00
If you find yourself manually constructing URLs with **querystring parameters**
2012-08-06 22:33:40 +02:00
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 you shell. Also, special characters in parameter values,
will also automatically escaped (HTTPie otherwise expects the URL to be
already escaped). To search for ``HTTPie logo`` on Google Images you could use
this command:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
2016-03-01 16:48:13 +01:00
$ http www.google.com search=='HTTPie logo' tbm==isch
2012-08-06 22:33:40 +02:00
.. code-block:: http
2016-03-01 16:48:13 +01:00
GET /?search=HTTPie+logo&tbm=isch HTTP/1.1
2012-08-06 22:33:40 +02:00
=============
Request Items
=============
There are a few different *request item* types that provide a
2012-08-06 22:33:40 +02:00
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.
2012-08-06 22:33:40 +02:00
+-----------------------+-----------------------------------------------------+
| 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. |
2015-03-10 09:05:13 +01:00
| | 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 |
2014-01-25 15:07:22 +01:00
| ``field=value``, | object (default), or to be form-encoded |
| ``field=@file.txt`` | (``--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 |
| ``field:=json``, | more fields need to be a ``Boolean``, ``Number``, |
| ``field:=@file.json`` | nested ``Object``, or an ``Array``, e.g., |
2012-08-06 22:33:40 +02:00
| | ``meals:='["ham","spam"]'`` or ``pies:=[1,2,3]`` |
| | (note the quotes). |
2012-07-26 09:01:30 +02:00
+-----------------------+-----------------------------------------------------+
| Form File Fields | Only available with ``--form, -f``. |
2012-08-06 22:33:40 +02:00
| ``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
2012-09-24 05:59:52 +02:00
(or parts thereof). For instance, ``foo\==bar`` will become a data key/value
2012-08-06 22:33:40 +02:00
pair (``foo=`` and ``bar``) instead of a URL parameter.
2012-07-26 09:01:30 +02:00
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 httpbin.org/post -- -name-starting-with-dash=foo --Weird-Header:bar
.. code-block:: http
2016-02-28 12:32:19 +01:00
POST /post HTTP/1.1
2016-02-28 14:37:49 +01:00
--Weird-Header: bar
{
"-name-starting-with-dash": "value"
}
2012-09-24 05:59:52 +02:00
Note that data fields aren't the only way to specify request data:
`Redirected input`_ allows for 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``
2012-08-06 22:33:40 +02:00
``Accept`` ``application/json``
================ =======================================
2012-03-05 00:48:06 +01:00
2013-04-11 09:00:41 +02: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
2016-03-01 09:50:30 +01:00
``http url Accept:application/json``). Additionally,
HTTPie will try to detect JSON responses even when the
``Content-Type`` is incorrectly ``text/plain`` or unknown.
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: gzip, deflate
Content-Type: application/json
2012-08-06 22:33:40 +02:00
Host: example.org
{
"name": "John",
"email": "john@example.org"
}
Non-string fields use the ``:=`` separator, which allows you to embed raw JSON
into the resulting object. Text and raw JSON files can also be embedded into
fields using ``=@`` and ``:=@``:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
$ http PUT api.example.com/person/1 \
name=John \
age:=29 married:=false hobbies:='["http", "pies"]' \ # Raw JSON
description=@about-john.txt \ # Embed text file
bookmarks:=@bookmarks.json # Embed JSON file
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
2012-08-06 22:33:40 +02:00
Host: api.example.com
{
"age": 29,
"hobbies": [
"http",
"pies"
],
"description": "John is a nice guy who likes pies.",
2012-08-06 22:33:40 +02:00
"married": false,
"name": "John",
"bookmarks": {
"HTTPie": "http://httpie.org",
}
2012-08-06 22:33:40 +02:00
}
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
2013-04-11 09:00:41 +02:00
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``.
2012-09-24 05:59:52 +02:00
It is possible to make form data the implicit content type instead of JSON
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
2015-03-10 09:05:13 +01:00
$ http --form POST api.example.org/person/1 name='John Smith' \
email=john@example.org cv=@~/Documents/cv.txt
2012-08-06 22:33:40 +02:00
.. code-block:: http
POST /person/1 HTTP/1.1
2012-03-05 00:48:06 +01:00
Content-Type: application/x-www-form-urlencoded; charset=utf-8
name=John+Smith&email=john%40example.org&cv=John's+CV+...
2012-08-06 22:33:40 +02:00
-----------------
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>
Note that ``@`` is used to simulate a file upload form field, whereas
``=@`` just embeds the file content as a regular text field value.
2012-08-06 22:33:40 +02:00
============
HTTP Headers
============
To set custom headers you can use the ``Header:Value`` notation:
.. code-block:: bash
2015-03-10 09:05:13 +01:00
$ http example.org User-Agent:Bacon/1.0 'Cookie:valued-visitor=yes;foo=bar' \
X-Foo:Bar Referer:http://httpie.org/
2012-08-06 22:33:40 +02:00
.. code-block:: http
GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Cookie: valued-visitor=yes;foo=bar
2012-08-06 22:33:40 +02:00
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: gzip, deflate
2012-08-06 22:33:40 +02:00
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
2013-09-22 15:10:50 +02:00
The currently supported authentication schemes are Basic and Digest
(see `auth plugins`_ for more). 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.
2015-03-10 09:05:13 +01:00
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).
2012-08-06 22:33:40 +02:00
``--auth-type, -A`` Specify the auth mechanism. Possible values are
2012-08-06 22:33:40 +02:00
``basic`` and ``digest``. The default value is
``basic`` so it can often be omitted.
=================== ======================================================
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
$ http -A 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
2013-09-22 15:20:50 +02:00
Authorization information from your ``~/.netrc`` file is honored as well:
.. code-block:: bash
2013-09-22 15:20:50 +02:00
$ cat ~/.netrc
machine httpbin.org
login httpie
password test
2013-09-22 15:19:59 +02:00
$ http httpbin.org/basic-auth/httpie/test
HTTP/1.1 200 OK
[...]
2013-09-22 15:10:50 +02:00
------------
Auth Plugins
------------
2013-09-21 23:46:15 +02:00
2015-07-03 03:40:38 +02:00
* `httpie-oauth <https://github.com/jkbrzt/httpie-oauth>`_: OAuth
2016-01-15 18:07:41 +01:00
* `httpie-hmac-auth <https://github.com/guardian/httpie-hmac-auth>`_: HMAC
2015-07-03 03:40:38 +02:00
* `httpie-ntlm <https://github.com/jkbrzt/httpie-ntlm>`_: NTLM (NT LAN Manager)
* `httpie-negotiate <https://github.com/ndzou/httpie-negotiate>`_: SPNEGO (GSS Negotiate)
2014-07-17 00:48:56 +02:00
* `requests-hawk <https://github.com/mozilla-services/requests-hawk>`_: Hawk
* `httpie-api-auth <https://github.com/pd/httpie-api-auth>`_: ApiAuth
2015-06-30 11:51:40 +02:00
* `httpie-edgegrid <https://github.com/akamai-open/httpie-edgegrid>`_: EdgeGrid
2015-09-01 15:11:36 +02:00
* `httpie-jwt-auth <https://github.com/teracyhq/httpie-jwt-auth>`_: JWTAuth (JSON Web Tokens)
2013-09-21 23:46:15 +02:00
==============
HTTP Redirects
==============
By default, HTTP redirects are not followed and only the first
response is shown. To instruct HTTPie to follow the ``Location`` header of
``30x`` responses and show the final response instead, use the ``--follow, -F`` option.
2016-02-29 07:21:25 +01:00
If you additionally wish to see the intermediary requests/responses,
then use the ``--all`` option as well.
To change the default limit of maximum 30 redirects, use the
``--max-redirects=<limit>`` option.
2016-02-29 07:21:25 +01:00
.. code-block:: bash
$ http --follow --all --max-redirects=5 httpbin.org/redirect/3
2016-02-29 07:21:25 +01:00
2012-08-07 14:49:43 +02:00
=======
Proxies
=======
2013-04-11 09:00:41 +02:00
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):
2012-08-07 14:49:43 +02:00
.. code-block:: bash
$ http --proxy=http:http://10.10.1.10:3128 --proxy=https:https://10.10.1.10:1080 example.org
2012-08-07 14:49:43 +02:00
With Basic authentication:
.. code-block:: bash
2012-09-24 05:59:52 +02:00
$ http --proxy=http:http://user:pass@10.10.1.10:3128 example.org
2012-08-07 14:49:43 +02:00
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=http://10.10.1.10:3128
export HTTPS_PROXY=https://10.10.1.10:1080
2012-08-07 14:49:43 +02:00
export NO_PROXY=localhost,example.com
2012-08-07 15:25:24 +02:00
=====
HTTPS
=====
2015-01-24 00:22:31 +01:00
-----------------------------------
Server SSL certificate verification
-----------------------------------
2012-08-07 15:25:24 +02:00
2015-01-24 00:22:31 +01:00
To skip the **host's SSL certificate verification,** you can pass
``--verify=no`` (default is ``yes``):
2014-02-05 12:51:05 +01:00
2015-01-24 00:22:31 +01:00
.. code-block:: bash
$ http --verify=no https://example.org
2015-01-24 00:41:22 +01:00
You can also use ``--verify=<CA_BUNDLE_PATH>`` to set a **custom CA bundle**
path:
2015-01-24 00:22:31 +01:00
.. code-block:: bash
$ http --verify=/ssl/custom_ca_bundle https://example.org
The path can also be configured via the environment variable
``REQUESTS_CA_BUNDLE`` (picked up by the underlying python-requests library):
.. code-block:: bash
$ REQUESTS_CA_BUNDLE=/ssl/custom_ca_bundle http 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
2015-01-24 00:41:22 +01:00
If the **private key** is not contained in the cert file you may pass the
2015-01-24 00:22:31 +01:00
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>`` 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
2016-04-19 00:11:04 +02:00
are ``ssl2.3``, ``ssl3``, ``tls1``, ``tls1.1``, ``tls1.2``. (The actually
2016-03-02 06:42:42 +01:00
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
2015-01-24 00:22:31 +01:00
----------------------------
SNI (Server Name Indication)
----------------------------
2015-01-24 00:41:22 +01:00
If you use HTTPie with Python < 2.7.9
(can be verified with ``python --version``) and need to talk to servers that
use **SNI (Server Name Indication)** you need to install some additional
2015-01-24 00:22:31 +01:00
dependencies:
.. code-block:: bash
$ pip install --upgrade pyopenssl pyasn1 ndg-httpsclient
You can use the following command to test SNI support:
.. code-block:: bash
$ http https://sni.velox.ch
2012-08-07 15:25:24 +02:00
2012-08-06 22:33:40 +02:00
==============
Output Options
==============
2016-03-07 00:09:58 +01:00
By default, HTTPie only outputs the final response and the whole response
message is printed (headers as well as the body).
2012-08-06 22:33:40 +02:00
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 bellow).
2012-08-06 22:33:40 +02:00
``--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: gzip, deflate
Content-Type: application/json
2012-08-06 22:33:40 +02:00
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
{
[…]
}
2013-04-11 09:00:41 +02:00
All the other options are just a shortcut for ``--print, -p``.
2012-08-06 22:33:40 +02:00
It accepts a string of characters each of which represents a specific part of
the HTTP exchange:
========== ==================
Character Stands for
========== ==================
2016-03-10 07:27:33 +01:00
``H`` request headers
``B`` request body
``h`` response headers
``b`` response body
2012-08-06 22:33:40 +02:00
========== ==================
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
---------------------------------------
Viewing Intermediary Requests/Responses
---------------------------------------
2016-03-17 08:00:50 +01:00
To see *all* the HTTP communication, i.e. the final request/resposne as
well as any possible intermediary requests/responses, use the **``--all``**
option. The intermediary HTTP communication include followed redirects
2016-03-10 07:27:33 +01:00
(with ``--follow``), the first unauthorized request when HTTP digest
authentication is used (``--auth=digest``), etc.
.. code-block:: bash
2016-03-10 07:27:33 +01:00
# Include all responses that lead to the final one:
$ http --all --follow httpbin.org/redirect/3
2016-03-10 07:27:33 +01:00
The intermediary requests/response are by default formatted according to
``--print, -p`` (and its shortcuts described above). If you'd like to change
2016-03-17 08:00:50 +01:00
that, use the **``--print-others, -P``** option. It takes the same
2016-03-10 07:27:33 +01:00
arguments as ``--print, -p`` but applies to the intermediary requests only.
.. code-block:: bash
2016-03-10 07:27:33 +01:00
# Print the intermediary requests/responses differently than the final one:
$ http -A digest -a foo:bar --all -p Hh -P H httpbin.org/digest-auth/auth/foo/bar
2012-08-06 22:33:40 +02:00
-------------------------
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 '401 Unauthorized' /var/log/httpd/error_log | http POST example.org/intruders
2012-08-06 22:33:40 +02:00
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
2015-07-03 03:40:38 +02:00
$ http GET https://api.github.com/repos/jkbrzt/httpie | http POST httpbin.org/post
2012-08-06 22:33:40 +02:00
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
2013-08-01 08:46:37 +02:00
on the command line:
.. code-block:: bash
$ echo 'data' | http POST example.org more=data # This is invalid
2012-08-06 22:33:40 +02:00
2013-08-23 10:57:17 +02:00
To prevent HTTPie from reading ``stdin`` data you can use the
``--ignore-stdin`` option.
2012-08-06 22:33:40 +02:00
-------------------------
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
2014-04-24 18:20:23 +02:00
===============
2012-08-06 22:33:40 +02:00
Terminal Output
2014-04-24 18:20:23 +02:00
===============
2012-08-06 22:33:40 +02:00
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
2015-10-07 19:17:53 +02:00
sense). You can choose your preferred 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-09-24 05:59:52 +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-12-01 15:54:36 +01:00
You can create a shortcut for invoking HTTPie with colorized and paged output
2012-12-01 16:20:16 +01:00
by adding the following to your ``~/.bash_profile``:
2012-12-01 15:54:36 +01:00
.. code-block:: bash
function httpless {
# `httpless example.org'
http --pretty=all --print=hb "$@" | less -R;
2012-12-01 15:54:36 +01:00
}
2012-08-09 23:36:29 +02:00
=============
Download Mode
=============
2013-04-12 16:06:03 +02:00
HTTPie features a download mode in which it acts similarly to ``wget``.
When enabled using the ``--download, -d`` flag, response headers are printed to
the terminal (``stderr``), and a progress bar is shown while the response body
is being saved to a file.
.. code-block:: bash
2016-02-28 09:19:18 +01:00
$ http --download https://github.com/jkbrzt/httpie/archive/master.tar.gz
2013-04-12 16:06:03 +02:00
.. code-block:: http
HTTP/1.1 200 OK
2016-02-28 09:19:18 +01:00
Content-Disposition: attachment; filename=httpie-master.tar.gz
Content-Length: 257336
2013-04-12 16:06:03 +02:00
Content-Type: application/x-gzip
2016-02-28 09:19:18 +01:00
Downloading 251.30 kB to "httpie-master.tar.gz"
Done. 251.30 kB in 2.73862s (91.76 kB/s)
2013-04-12 16:06:03 +02:00
If not provided via ``--output, -o``, the output filename will be determined
from ``Content-Disposition`` (if available), or from the URL and
``Content-Type``. If the guessed filename already exists, HTTPie adds a unique
suffix to it.
You can also redirect the response body to another program while the response
headers and progress are still shown in the terminal:
.. code-block:: bash
2016-02-28 09:19:18 +01:00
$ http -d https://github.com/jkbrzt/httpie/archive/master.tar.gz | tar zxf -
2013-04-12 16:06:03 +02:00
If ``--output, -o`` is specified, you can resume a partial download using the
``--continue, -c`` option. This only works with servers that support
``Range`` requests and ``206 Partial Content`` responses. If the server doesn't
support that, the whole file will simply be downloaded:
.. code-block:: bash
2013-04-12 16:37:58 +02:00
$ http -dco file.zip example.org/file
2013-04-12 16:06:03 +02:00
Other notes:
* The ``--download`` option only changes how the response body is treated.
2013-04-27 16:57:13 +02:00
* You can still set custom headers, use sessions, ``--verbose, -v``, etc.
2013-04-12 16:06:03 +02:00
* ``--download`` always implies ``--follow`` (redirects are followed).
2013-04-12 16:26:42 +02:00
* HTTPie exits with status code ``1`` (error) if the body hasn't been fully
2013-04-12 16:06:03 +02:00
downloaded.
* ``Accept-Encoding`` cannot be set with ``--download``.
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
========
By default, every request is completely independent of any previous ones.
HTTPie also supports persistent sessions, where custom headers (except for the
ones starting with ``Content-`` or ``If-``), authorization, and cookies
(manually specified or sent by the server) persist between requests
to the same host.
2012-09-21 05:43:34 +02:00
--------------
Named Sessions
--------------
Create a new session named ``user1`` for ``example.org``:
.. code-block:: bash
2012-09-21 05:43:34 +02:00
$ http --session=user1 -a user1:password example.org X-Foo:Bar
2012-09-24 05:59:52 +02:00
Now you can refer to the session by its name, and the previously used
authorization and HTTP headers will automatically be set:
.. 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.
Named sessions' data is stored in JSON files in the directory
2012-12-01 18:43:33 +01:00
``~/.httpie/sessions/<host>/<name>.json``
(``%APPDATA%\httpie\sessions\<host>\<name>.json`` on Windows).
------------------
Anonymous Sessions
------------------
Instead of a name, you can also directly specify a path to a session file. This
2013-05-13 15:35:12 +02:00
allows for sessions to be re-used across multiple hosts:
.. code-block:: bash
$ http --session=/tmp/session.json example.org
$ http --session=/tmp/session.json admin.example.org
$ http --session=~/.httpie/sessions/another.example.org/test.json example.org
$ http --session-read-only=/tmp/session.json example.org
2012-12-01 18:43:33 +01:00
**Warning:** All session data, including credentials, cookie data,
and custom headers are stored in plain text.
Note that session files can also be created and edited manually in a text
editor; they are plain JSON.
2012-12-01 18:43:33 +01:00
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:
2016-03-03 10:21:51 +01:00
------------
``__meta__``
------------
2016-03-03 10:21:51 +01:00
HTTPie automatically stores some of its metadata here. Do not change.
2016-03-03 10:21:51 +01:00
-------------------
``default_options``
-------------------
An ``Array`` (by default empty) of default options that should be applied to
every invocation of HTTPie.
For instance, you can use this option to change the default style and output
2016-03-03 10:24:46 +01:00
options: ``"default_options": ["--style=fruity", "--body"]`` Another useful
default option could be ``"--session=default"`` to make HTTPie always
2016-03-03 10:26:47 +01:00
use `sessions`_ (one named ``default`` will automatically be used).
Or you could change the implicit request content type from JSON to form by
2016-03-03 10:24:46 +01:00
adding ``--form`` to the list.
Default options from config file can be unset for a particular invocation via
``--no-OPTION`` arguments passed on the command line (e.g., ``--no-style``
2016-03-03 10:24:46 +01:00
or ``--no-session``). The default location of the configuration file is
``~/.httpie/config.json`` (or ``%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``,
2013-08-23 10:57:17 +02:00
respectively.
The ``--ignore-stdin`` option prevents HTTPie from reading data from ``stdin``,
which is usually not desirable during non-interactive invocations.
Also, the ``--timeout`` option allows to overwrite the default 30s timeout:
2012-08-06 22:33:40 +02:00
.. code-block:: bash
#!/bin/bash
2013-08-23 10:57:17 +02:00
if http --check-status --ignore-stdin --timeout=2.5 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!' ;;
6) echo 'Exceeded --max-redirects=<n> redirects!' ;;
*) 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
2015-02-16 21:29:40 +01:00
`change log`_.
2016-02-29 17:24:52 +01:00
=======
Support
=======
2016-03-02 06:42:42 +01:00
Please use the following support channels:
* `GitHub issues <https://github.com/jkbr/httpie/issues>`_
2016-02-29 17:24:52 +01:00
for bug reports and feature requests.
2016-03-02 06:42:42 +01:00
* `Our Gitter chat room <https://gitter.im/jkbrzt/httpie>`_
to ask questions, discuss features, and for general discussion.
* `StackOverflow <https://stackoverflow.com>`_
to ask questions (please make sure to use the
2016-02-29 17:24:52 +01:00
`httpie <http://stackoverflow.com/questions/tagged/httpie>`_ tag).
2016-02-29 17:45:54 +01:00
* You can also tweet directly to `@jkbrzt`_.
2016-02-29 17:24:52 +01:00
=======
Authors
=======
2012-08-09 23:36:29 +02:00
2012-08-06 22:33:40 +02:00
2015-07-03 03:40:38 +02:00
`Jakub Roztocil`_ (`@jkbrzt`_) created HTTPie and `these fine people`_
have contributed.
2012-06-15 17:13:40 +02:00
2012-08-06 22:33:40 +02:00
2014-04-24 18:20:23 +02:00
====
Logo
2014-04-24 18:20:23 +02:00
====
2014-04-24 18:20:23 +02:00
Please see `claudiatd/httpie-artwork`_
2012-07-26 09:01:30 +02:00
2015-02-16 21:29:40 +01:00
==========
Contribute
==========
2015-07-03 03:40:38 +02:00
Please see `CONTRIBUTING <https://github.com/jkbrzt/httpie/blob/master/CONTRIBUTING.rst>`_.
2015-02-16 21:29:40 +01:00
==========
Change Log
==========
2015-07-03 03:40:38 +02:00
Please see `CHANGELOG <https://github.com/jkbrzt/httpie/blob/master/CHANGELOG.rst>`_.
2015-02-16 21:29:40 +01:00
2012-08-06 22:33:40 +02:00
=======
Licence
=======
2015-07-03 03:40:38 +02:00
Please see `LICENSE <https://github.com/jkbrzt/httpie/blob/master/LICENSE>`_.
2012-08-06 22:33:40 +02:00
2012-07-26 09:01:30 +02:00
.. _Requests: http://python-requests.org
.. _Pygments: http://pygments.org/
.. _pip: http://www.pip-installer.org/en/latest/index.html
2012-08-06 22:33:40 +02:00
.. _Github API: http://developer.github.com/v3/issues/comments/#create-a-comment
2015-07-03 03:40:38 +02:00
.. _these fine people: https://github.com/jkbrzt/httpie/contributors
.. _Jakub Roztocil: http://roztocil.co
.. _@jkbrzt: https://twitter.com/jkbrzt
.. _claudiatd/httpie-artwork: https://github.com/claudiatd/httpie-artwork
.. |pypi| image:: https://img.shields.io/pypi/v/httpie.svg?style=flat-square&label=latest%20stable%20version
2015-02-15 00:51:58 +01:00
:target: https://pypi.python.org/pypi/httpie
2015-02-15 11:28:53 +01:00
:alt: Latest version released on PyPi
2016-02-29 17:08:07 +01:00
.. |coverage| image:: https://img.shields.io/coveralls/jkbrzt/httpie/master.svg?style=flat-square&label=coverage
2015-07-03 03:40:38 +02:00
:target: https://coveralls.io/r/jkbrzt/httpie?branch=master
2015-02-15 11:28:53 +01:00
:alt: Test coverage
2015-01-31 17:49:23 +01:00
2016-02-29 17:08:07 +01:00
.. |unix_build| image:: https://img.shields.io/travis/jkbrzt/httpie/master.svg?style=flat-square&label=unix%20build
2015-07-03 03:40:38 +02:00
:target: http://travis-ci.org/jkbrzt/httpie
2015-02-15 11:28:53 +01:00
:alt: Build status of the master branch on Mac/Linux
2016-02-29 17:08:07 +01:00
.. |windows_build| image:: https://img.shields.io/appveyor/ci/jkbrzt/httpie.svg?style=flat-square&label=windows%20build
2015-07-03 03:40:38 +02:00
:target: https://ci.appveyor.com/project/jkbrzt/httpie
2015-02-15 11:28:53 +01:00
:alt: Build status of the master branch on Windows
2016-02-29 17:08:07 +01:00
.. |gitter| image:: https://badges.gitter.im/jkbrzt/httpie.svg
:target: https://gitter.im/jkbrzt/httpie
:alt: Chat on Gitter