mirror of
https://github.com/httpie/cli.git
synced 2024-11-30 11:43:53 +01:00
93 lines
4.2 KiB
Markdown
93 lines
4.2 KiB
Markdown
<br/>
|
|
<a href="https://httpie.io" target="blank_">
|
|
<img height="100" alt="HTTPie" src="https://raw.githubusercontent.com/httpie/httpie/master/docs/httpie-logo.svg" />
|
|
</a>
|
|
<br/>
|
|
|
|
# HTTPie: human-friendly CLI HTTP client for the API era
|
|
|
|
HTTPie (pronounced _aitch-tee-tee-pie_) is a command-line HTTP client.
|
|
Its goal is to make CLI interaction with web services as human-friendly as possible.
|
|
HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.
|
|
The `http` & `https` commands allow for creating and sending arbitrary HTTP requests.
|
|
They use simple and natural syntax and provide formatted and colorized output.
|
|
|
|
[](https://httpie.org/docs)
|
|
[](https://pypi.python.org/pypi/httpie)
|
|
[](https://github.com/httpie/httpie/actions)
|
|
[](https://codecov.io/gh/httpie/httpie)
|
|
[](https://twitter.com/httpie)
|
|
[](https://httpie.io/discord)
|
|
|
|
<img src="https://raw.githubusercontent.com/httpie/httpie/master/docs/httpie-animation.gif" alt="HTTPie in action" width="100%"/>
|
|
|
|
|
|
## We lost 54k GitHub stars
|
|
|
|
Please note we recently accidentally made this repo private for a moment, and GitHub deleted our community that took a decade to build. Read the full story here: https://httpie.io/blog/stardust
|
|
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
- [Installation instructions →](https://httpie.io/docs#installation)
|
|
- [Full documentation →](https://httpie.io/docs)
|
|
|
|
## Features
|
|
|
|
- Expressive and intuitive syntax
|
|
- Formatted and colorized terminal output
|
|
- Built-in JSON support
|
|
- Forms and file uploads
|
|
- HTTPS, proxies, and authentication
|
|
- Arbitrary request data
|
|
- Custom headers
|
|
- Persistent sessions
|
|
- `wget`-like downloads
|
|
|
|
[See all features →](https://httpie.io/docs)
|
|
|
|
## Examples
|
|
|
|
Hello World:
|
|
|
|
```bash
|
|
$ https httpie.io/hello
|
|
```
|
|
|
|
Custom [HTTP method](https://httpie.io/docs#http-method), [HTTP headers](https://httpie.io/docs#http-headers) and [JSON](https://httpie.io/docs#json) data:
|
|
|
|
```bash
|
|
$ http PUT pie.dev/put X-API-Token:123 name=John
|
|
```
|
|
|
|
Build and print a request without sending it using [offline mode](https://httpie.io/docs#offline-mode):
|
|
|
|
```bash
|
|
$ http --offline pie.dev/post hello=offline
|
|
```
|
|
|
|
Use [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comment) to post a comment on an [Issue](https://github.com/httpie/httpie/issues/83) with [authentication](https://httpie.io/docs#authentication):
|
|
|
|
```bash
|
|
$ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'
|
|
```
|
|
|
|
[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/discord) 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
|
|
|
|
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.
|
|
|
|
[See contribution guide →](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md)
|