mirror of
https://github.com/httpie/cli.git
synced 2024-11-22 15:53:13 +01:00
Readme tweaks (#1141)
This commit is contained in:
parent
6039bd8582
commit
7e9e7c783f
91
README.md
91
README.md
@ -1,50 +1,44 @@
|
|||||||
<br/>
|
<br/>
|
||||||
<a href="https://httpie.io" target="blank_">
|
<a href="https://httpie.io" target="blank_">
|
||||||
<img width="285" alt="Httpie-Logo-Lockup-Pink@2x" src="https://user-images.githubusercontent.com/22844059/112143133-5fff7380-8bcf-11eb-85d0-8efdf27f3991.png">
|
<img height="100" alt="HTTPie" src="https://raw.githubusercontent.com/httpie/httpie/master/docs/httpie-logo.svg" />
|
||||||
</a>
|
</a>
|
||||||
|
<br/>
|
||||||
|
|
||||||
# HTTPie: the human-friendly HTTP CLI client for working with APIs
|
# HTTPie: human-friendly CLI HTTP client for the API era
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif" width="600"/>
|
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.
|
||||||
|
|
||||||
[![Build](https://img.shields.io/github/workflow/status/httpie/httpie/Build?color=%2373DC8C&label=Build&logo=github)](https://github.com/httpie/httpie/actions)
|
[![Docs](https://img.shields.io/badge/stable%20docs-httpie.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://httpie.org/docs)
|
||||||
[![Latest version](https://img.shields.io/pypi/v/httpie.svg?style=flat&label=Latest%20stable%20version&color=%23FA9BFA&logo=pypi&logoColor=white)](https://pypi.python.org/pypi/httpie)
|
[![Latest version](https://img.shields.io/pypi/v/httpie.svg?style=flat&label=Latest&color=%234B78E6&logo=&logoColor=white)](https://pypi.python.org/pypi/httpie)
|
||||||
[![Coverage](https://img.shields.io/codecov/c/github/httpie/httpie?style=flat&label=Coverage&color=%237D7D7D&logo=codecov)](https://codecov.io/gh/httpie/httpie)
|
[![Build](https://img.shields.io/github/workflow/status/httpie/httpie/Build?color=%23FA9BFA&label=Build)](https://github.com/httpie/httpie/actions)
|
||||||
[![Downloads](https://img.shields.io/pypi/dm/httpie?color=%23DBDE52&label=Downloads&logo=python)](https://pepy.tech/project/httpie)
|
[![Coverage](https://img.shields.io/codecov/c/github/httpie/httpie?style=flat&label=Coverage&color=%2373DC8C)](https://codecov.io/gh/httpie/httpie)
|
||||||
|
[![Twitter](https://img.shields.io/twitter/follow/httpie?style=flat&color=%234B78E6&logoColor=%234B78E6)](https://twitter.com/httpie)
|
||||||
|
[![Chat](https://img.shields.io/badge/chat-Discord-brightgreen?style=flat&label=Chat%20on&color=%23FA9BFA)](https://httpie.io/chat)
|
||||||
|
|
||||||
[![Issues](https://img.shields.io/github/issues/httpie/httpie?style=flat&color=%23FFA24E&label=Issues&logo=github)](https://github.com/httpie/httpie/issues)
|
<img src="https://raw.githubusercontent.com/httpie/httpie/master/docs/httpie-animation.gif" alt="HTTPie in action" width="100%"/>
|
||||||
[![Docs](https://img.shields.io/badge/stable%20docs-httpie.org%2Fdocs-brightgreen?style=flat&color=%234B78E6&label=Stable%20docs)](https://httpie.org/docs)
|
|
||||||
[![Chat](https://img.shields.io/badge/chat-on%20Discord-brightgreen?style=flat&logo=discord&label=Chat%20on&color=%23B464F0)](https://httpie.io/chat)
|
|
||||||
|
|
||||||
HTTPie (pronounced _aitch-tee-tee-pie_ 🥧) is a command-line HTTP client.
|
## Getting started
|
||||||
|
|
||||||
The `http` and `https` commands let you send arbitrary HTTP requests for testing, debugging, and generally interacting with APIs & HTTP servers. Commands use simple, natural syntax and provide a formatted and colorized output.
|
- [Installation instructions →](https://httpie.io/docs#installation)
|
||||||
|
- [Full documentation →](https://httpie.io/docs)
|
||||||
**Visit [httpie.io](https://httpie.io) to learn more**
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Simple syntax
|
- Expressive and intuitive syntax
|
||||||
- Formatted and colorized terminal output
|
- Formatted and colorized terminal output
|
||||||
- Built-in JSON support
|
- Built-in JSON support
|
||||||
- Forms and file uploads
|
- Forms and file uploads
|
||||||
- HTTPS, proxies, and authentication
|
- HTTPS, proxies, and authentication
|
||||||
|
- Arbitrary request data
|
||||||
|
- Custom headers
|
||||||
- Persistent sessions
|
- Persistent sessions
|
||||||
- Wget-like downloads
|
- `wget`-like downloads
|
||||||
- Linux, macOS and Windows support
|
|
||||||
- Plugins, such as JWTAuth and OAuth
|
|
||||||
|
|
||||||
See the [complete list of features](https://httpie.io/docs).
|
[See for all features →](https://httpie.io/docs)
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
Full documentation and installation guides live in [httpie.io/docs](https://httpie.io/docs).
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
HTTPie can be installed using Homebrew on macOS (`brew install httpie`), and `pip` on Linux, Windows and other Operating Systems (e.g. `python -m pip install --upgrade httpie`).
|
|
||||||
|
|
||||||
See the [docs](https://httpie.io/docs) for system requirements and full installation instructions.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -72,34 +66,19 @@ Use [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comme
|
|||||||
$ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'
|
$ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'
|
||||||
```
|
```
|
||||||
|
|
||||||
**See [the documentation](https://httpie.io/docs) for a complete list of examples and use cases.**
|
[See more examples →](https://httpie.io/docs#examples)
|
||||||
|
|
||||||
|
## Community & support
|
||||||
|
|
||||||
|
- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links.
|
||||||
|
- Join our [Discord server](https://httpie.io/chat) is to ask questions, discuss features, and for general API chat.
|
||||||
|
- Tweet at [@httpie](https://twitter.com/httpie) on Twitter.
|
||||||
|
- Use [StackOverflow](https://stackoverflow.com/questions/tagged/httpie) to ask questions and include a `httpie` tag.
|
||||||
|
- Create [GitHub Issues](https://github.com/httpie/httpie/issues) for bug reports and feature requests.
|
||||||
|
- Subscribe to the [HTTPie newsletter](https://httpie.io) for occasional updates.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We :sparkling_heart: our contributors! Please read the [contribution guide](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md) for how to contribute.
|
Have a look through existing [Issues](https://github.com/httpie/httpie/issues) and [Pull Requests](https://github.com/httpie/httpie/pulls) that you could help with. If you'd like to request a feature or report a bug, please [create a GitHub Issue](https://github.com/httpie/httpie/issues) using one of the templates provided.
|
||||||
Have a look through existing [Issues](https://github.com/httpie/httpie/issues) and [Pull Requests](https://github.com/httpie/httpie/pulls) that you could help with.
|
|
||||||
|
|
||||||
[![Issues](https://img.shields.io/github/issues/httpie/httpie?style=flat&color=%23FFA24E&label=Issues&logo=github)](https://github.com/httpie/httpie/issues)
|
[See full contribution guide →](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md)
|
||||||
[![PRs](https://img.shields.io/github/issues-pr/httpie/httpie?color=%23FA9BFA&label=Pull%20Requests&logo=github)](https://github.com/httpie/httpie/pulls)
|
|
||||||
|
|
||||||
If you'd like to request a feature or report a bug, please [create a GitHub Issue](https://github.com/httpie/httpie/issues) using one of the templates provided.
|
|
||||||
|
|
||||||
## Community & Support
|
|
||||||
|
|
||||||
- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links.
|
|
||||||
|
|
||||||
- Join our [Discord server](https://httpie.io/chat) is to ask questions, discuss features, and for general API chat.
|
|
||||||
|
|
||||||
- Tweet at [@httpie](https://twitter.com/httpie) on Twitter.
|
|
||||||
|
|
||||||
- Use [StackOverflow](https://stackoverflow.com/questions/tagged/httpie) to ask questions and include a `httpie` tag.
|
|
||||||
|
|
||||||
- Create [GitHub Issues](https://github.com/httpie/httpie/issues) for bug reports and feature requests.
|
|
||||||
|
|
||||||
- Subscribe to the [HTTPie newsletter](https://httpie.io) for occasional updates.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[![License](https://img.shields.io/github/license/httpie/httpie?color=%2373DC8C&label=License)](https://github.com/httpie/httpie/blob/master/LICENSE)
|
|
||||||
|
|
||||||
HTTPie is licensed under the [BSD-3-Clause License](https://github.com/httpie/httpie/blob/master/LICENSE).
|
|
||||||
|
@ -1,15 +1,14 @@
|
|||||||
<div class='hidden-website'>
|
<div class='hidden-website'>
|
||||||
|
|
||||||
# HTTPie Documentation
|
# HTTPie Documentation
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
**HTTPie (pronounced aitch-tee-tee-pie) is a command-line HTTP client.
|
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.
|
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.
|
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.
|
The `http` & `https` commands allow for creating and sending arbitrary HTTP requests.
|
||||||
They use simple and natural syntax and provide formatted and colorized output.**
|
They use simple and natural syntax and provide formatted and colorized output.
|
||||||
|
|
||||||
|
<div class='hidden-website'>
|
||||||
## About this document
|
## About this document
|
||||||
|
|
||||||
This documentation is best viewed at [httpie.io/docs](https://httpie.org/docs).
|
This documentation is best viewed at [httpie.io/docs](https://httpie.org/docs).
|
||||||
@ -19,6 +18,8 @@ You can select your corresponding HTTPie version as well as run examples directl
|
|||||||
If you are reading this on GitHub, then this text covers the current *development* version.
|
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 docs by editing [this file](https://github.com/httpie/httpie/blob/master/docs/README.md).
|
You are invited to submit fixes and improvements to the docs by editing [this file](https://github.com/httpie/httpie/blob/master/docs/README.md).
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
## Main features
|
## Main features
|
||||||
|
|
||||||
- Expressive and intuitive syntax
|
- Expressive and intuitive syntax
|
||||||
@ -1674,7 +1675,6 @@ See [CHANGELOG](https://github.com/httpie/httpie/blob/master/CHANGELOG.md).
|
|||||||
|
|
||||||
### Artwork
|
### Artwork
|
||||||
|
|
||||||
- Logo and branding by [HTTPie](https://httpie.io).
|
|
||||||
- [README Animation](https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif) by [Allen Smith](https://github.com/loranallensmith).
|
- [README Animation](https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif) by [Allen Smith](https://github.com/loranallensmith).
|
||||||
|
|
||||||
### Licence
|
### Licence
|
||||||
|
Before Width: | Height: | Size: 1019 KiB After Width: | Height: | Size: 1019 KiB |
1
docs/httpie-logo.svg
Normal file
1
docs/httpie-logo.svg
Normal file
@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1635.31 470"><defs><style>.cls-1{fill:#4b78e6;}</style></defs><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M1322.19,73.91h0a36.56,36.56,0,0,1,36.56-36.29h3.41a36.56,36.56,0,0,1,36.56,36.83h0a36.56,36.56,0,0,1-36.56,36.29h-3.41A36.56,36.56,0,0,1,1322.19,73.91Zm6.16,276.93V142.35a7.94,7.94,0,0,1,8-7.94h48.32a7.93,7.93,0,0,1,7.94,7.94V350.84a7.94,7.94,0,0,1-7.94,7.94H1336.3A8,8,0,0,1,1328.35,350.84Z"/><path class="cls-1" d="M1635.31,233.34c0-61.06-33.28-105.09-101.71-105.09-72.17,0-114.82,45.45-114.82,123.08,0,74.79,46.86,113.6,113.89,113.6,56.83,0,85.93-27.17,98.33-63.86a8,8,0,0,0-5.34-10.28l-40.32-11.39a8,8,0,0,0-9.54,4.73c-5.77,14.37-16.57,25.42-42.2,25.42-29.32,0-46.06-13.62-50.74-44.29a7.17,7.17,0,0,0,.81.08h143.7a8,8,0,0,0,7.94-7.94V242.23c0-.09,0-.18,0-.28C1635.31,239.17,1635.31,236.36,1635.31,233.34Zm-103.58-51.6c28.59,0,43.12,15.15,45,45H1483C1487.21,195,1503.61,181.74,1531.73,181.74Z"/><path class="cls-1" d="M581.91,358.75H533.56a7.93,7.93,0,0,1-7.94-7.94V76.39a7.93,7.93,0,0,1,7.94-7.94h48.35a7.93,7.93,0,0,1,7.94,7.94v84.66a6,6,0,0,0,11.22,2.77c13.45-25.56,34.68-35.33,60.42-35.69,38.66-.55,70,31.45,70,70.12V350.81a7.94,7.94,0,0,1-7.94,7.94H675.63a7.94,7.94,0,0,1-7.94-7.94V227.1c0-23.21-10.32-40.73-37-40.73-25.79,0-40.8,15.15-40.8,40.73V350.81A7.93,7.93,0,0,1,581.91,358.75Z"/><path class="cls-1" d="M1052.84,306.12a7.94,7.94,0,0,0-9.77-6.78c-6.47,1.55-13.73,3.05-20.35,3.05-19.23,0-25.79-8.52-25.79-26.52V188.26h50.67a7.94,7.94,0,0,0,7.94-7.94v-38.1a8,8,0,0,0-7.94-7.95H996.93V85.86A7.94,7.94,0,0,0,989,77.92H941.1a7.93,7.93,0,0,0-7.94,7.94v48.41H842.67V85.86a7.94,7.94,0,0,0-7.94-7.94H786.84a7.93,7.93,0,0,0-7.94,7.94v48.41H761.05a7.94,7.94,0,0,0-7.94,7.95v38.1a7.93,7.93,0,0,0,7.94,7.94H778.9v99.93c0,42.62,21.57,77.19,73.15,77.19,21.16,0,32.43-2.5,46.08-6.56a8,8,0,0,0,5.65-8.56l-5.2-44.14a7.94,7.94,0,0,0-9.77-6.78c-6.47,1.55-13.73,3.05-20.35,3.05-19.23,0-25.79-8.52-25.79-26.52V188.26h90.49v99.93c0,42.62,21.57,77.19,73.14,77.19,21.17,0,32.44-2.5,46.09-6.56a8,8,0,0,0,5.65-8.56Z"/><path class="cls-1" d="M1219.14,365.27c-28.49,0-49.51-10.92-62.87-35.86a6,6,0,0,0-11.19,2.84v82.83a7.93,7.93,0,0,1-7.94,7.94h-48.32a7.94,7.94,0,0,1-8-7.94V142.21a8,8,0,0,1,8-7.94h48.32a7.94,7.94,0,0,1,7.94,7.94v18.95c0,6.13,8.21,8.3,11.15,2.92,13.74-25.16,35.63-36,64.31-36,53.43,0,81.08,44,81.08,116.92C1301.62,320.78,1273,365.27,1219.14,365.27Zm19.21-119.76c0-37.39-14.06-59.17-46.4-59.17-29.53,0-46.87,20.35-46.87,57.28v4.26c0,36.45,17.34,59.17,46.87,59.17C1223.82,307.05,1238.35,284.33,1238.35,245.51Z"/><path class="cls-1" d="M394.41,102.12C394,45.31,346.61,0,289.8,0H104.69C48.31,0,1.09,44.6,0,101A103.07,103.07,0,0,0,103,205.92h82.7a6,6,0,0,1,2.39,11.42L61.31,272.91A103.09,103.09,0,0,0,0,367.83C.43,424.65,47.79,470,104.62,470H148c57.23,0,104.88-45.9,104.79-103.13a103.1,103.1,0,0,0-64.49-95.31,5.94,5.94,0,0,1-.1-10.94l145-63.58A103.08,103.08,0,0,0,394.41,102.12Z"/></g></g></svg>
|
After Width: | Height: | Size: 2.9 KiB |
BIN
httpie.png
BIN
httpie.png
Binary file not shown.
Before Width: | Height: | Size: 681 KiB |
Loading…
Reference in New Issue
Block a user