6039bd8582
* Convert most of the documentation from the frontend `README.rst` to `docs/REAME.md` Also converted all reStructuredText files to Markdown. * Tell `mdformat` to use LF for end on lines * `--check` is not needed in the help message * Skip tests on GitHub Windows. Those tests pass on a real Windows machine. Let's revisit those failure later, if needed. * Move `mdoformat` requirement from `test` to `dev` extra To fix Fedora CI.
HTTPie: the human-friendly HTTP CLI client for working with APIs
HTTPie (pronounced aitch-tee-tee-pie 🥧) is a command-line HTTP client.
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.
Visit httpie.io to learn more
Features
- Simple syntax
- Formatted and colorized terminal output
- Built-in JSON support
- Forms and file uploads
- HTTPS, proxies, and authentication
- Persistent sessions
- Wget-like downloads
- Linux, macOS and Windows support
- Plugins, such as JWTAuth and OAuth
See the complete list of features.
Documentation
Full documentation and installation guides live in 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 for system requirements and full installation instructions.
Examples
Hello World:
$ https httpie.io/hello
Custom HTTP method, HTTP headers and JSON data:
$ http PUT pie.dev/put X-API-Token:123 name=John
Build and print a request without sending it using offline mode:
$ http --offline pie.dev/post hello=offline
Use GitHub API to post a comment on an Issue with authentication:
$ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'
See the documentation for a complete list of examples and use cases.
Contributing
We 💖 our contributors! Please read the contribution guide for how to contribute. Have a look through existing Issues and Pull Requests that you could help with.
If you'd like to request a feature or report a bug, please create a GitHub Issue using one of the templates provided.
Community & Support
-
Visit the HTTPie website for full documentation and useful links.
-
Join our Discord server is to ask questions, discuss features, and for general API chat.
-
Tweet at @httpie on Twitter.
-
Use StackOverflow to ask questions and include a
httpietag. -
Create GitHub Issues for bug reports and feature requests.
-
Subscribe to the HTTPie newsletter for occasional updates.
License
HTTPie is licensed under the BSD-3-Clause License.