python/httpie-cli
1
0
Fork 0
mirror of https://github.com/httpie/cli.git synced 2024-11-24 08:22:22 +02:00
Code
621042a048
httpie-cli/README.md

113 lines
4.7 KiB
Markdown
Raw Normal View History

place the logo in the middle in README.md (#1393)
2022-07-12 17:33:57 +02:00
<h2 align="center">
<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>
Update README.md
2022-10-01 13:00:56 +02:00
HTTPie for Terminal: human-friendly CLI HTTP client for the API era
Update README.md
2022-08-10 16:38:40 +02:00
</h2>
🔥 Remove $ from code fenced examples on readme (#1435) * 🔥 Remove $ from code fenced examples on readme * 🚨 FIx markdownlint errors README.md:8: MD009 Trailing spaces README.md:10: MD009 Trailing spaces
2022-10-01 12:37:50 +02:00
Update README.md
2022-08-10 16:38:40 +02:00
<div align="center">
🔥 Remove $ from code fenced examples on readme (#1435) * 🔥 Remove $ from code fenced examples on readme * 🚨 FIx markdownlint errors README.md:8: MD009 Trailing spaces README.md:10: MD009 Trailing spaces
2022-10-01 12:37:50 +02:00
Update README.md
2022-08-10 16:38:40 +02:00
[![HTTPie for Desktop](https://img.shields.io/static/v1?label=HTTPie&message=for%20Desktop&color=4B78E6)](https://httpie.io/product)
[![](https://img.shields.io/static/v1?label=HTTPie&message=for%20Web%20%26%20Mobile&color=73DC8C)](https://httpie.io/app)
[![](https://img.shields.io/static/v1?label=HTTPie&message=for%20Terminal&color=FA9BFA)](https://httpie.io/cli)
Update README.md
2022-08-10 16:58:09 +02:00
[![Twitter](https://img.shields.io/twitter/follow/httpie?style=flat&color=%234B78E6&logoColor=%234B78E6)](https://twitter.com/httpie)
[![Chat](https://img.shields.io/discord/725351238698270761?style=flat&label=Chat%20on%20Discord&color=%23FA9BFA)](https://httpie.io/discord)
Update README.md
2022-08-10 16:38:40 +02:00
</div>
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Update README.md
2022-08-10 18:13:49 +02:00
<div align="center">
[![Docs](https://img.shields.io/badge/stable%20docs-httpie.io%2Fdocs%2Fcli-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://httpie.org/docs/cli)
[![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)
[![Build](https://img.shields.io/github/workflow/status/httpie/httpie/Build?color=%23FA9BFA&label=Build)](https://github.com/httpie/httpie/actions)
[![Coverage](https://img.shields.io/codecov/c/github/httpie/httpie?style=flat&label=Coverage&color=%2373DC8C)](https://codecov.io/gh/httpie/httpie)
</div>
Readme tweaks (#1141)
2021-09-06 20:17:21 +02: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.
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.
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Update README.md
2022-08-10 16:38:40 +02:00
<div align="center">
<img src="https://raw.githubusercontent.com/httpie/httpie/master/docs/httpie-animation.gif" alt="HTTPie in action" width="100%"/>
</div>
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Explain that we lost 54k stars in the README with a link to blog post
2022-04-14 18:27:18 +02:00
## 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
![](docs/stardust.png)
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
## Getting started
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Cleanup
2021-09-06 20:21:49 +02:00
- [Installation instructions →](https://httpie.io/docs#installation)
Cleanup
2021-09-06 20:23:00 +02:00
- [Full documentation →](https://httpie.io/docs)
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
## Features
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
- Expressive and intuitive syntax
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
- Formatted and colorized terminal output
- Built-in JSON support
- Forms and file uploads
- HTTPS, proxies, and authentication
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
- Arbitrary request data
- Custom headers
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
- Persistent sessions
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
- `wget`-like downloads
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Update README.md
2021-09-10 11:17:23 +02:00
[See all features →](https://httpie.io/docs)
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
## Examples
Hello World:
Add a workflow to check documentations (#1151) * Add a workflow to check documentations * Fix markdown issues * Install Ruby 2.7 * Finally, handle and fix GitHub templates * Minor improvement in the feature request template * Verbose mode to be sure all files are checked
2021-09-09 15:52:24 +02:00
```bash
🔥 Remove $ from code fenced examples on readme (#1435) * 🔥 Remove $ from code fenced examples on readme * 🚨 FIx markdownlint errors README.md:8: MD009 Trailing spaces README.md:10: MD009 Trailing spaces
2022-10-01 12:37:50 +02:00
https httpie.io/hello
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
```
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:
Add a workflow to check documentations (#1151) * Add a workflow to check documentations * Fix markdown issues * Install Ruby 2.7 * Finally, handle and fix GitHub templates * Minor improvement in the feature request template * Verbose mode to be sure all files are checked
2021-09-09 15:52:24 +02:00
```bash
🔥 Remove $ from code fenced examples on readme (#1435) * 🔥 Remove $ from code fenced examples on readme * 🚨 FIx markdownlint errors README.md:8: MD009 Trailing spaces README.md:10: MD009 Trailing spaces
2022-10-01 12:37:50 +02:00
http PUT pie.dev/put X-API-Token:123 name=John
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
```
Build and print a request without sending it using [offline mode](https://httpie.io/docs#offline-mode):
Add a workflow to check documentations (#1151) * Add a workflow to check documentations * Fix markdown issues * Install Ruby 2.7 * Finally, handle and fix GitHub templates * Minor improvement in the feature request template * Verbose mode to be sure all files are checked
2021-09-09 15:52:24 +02:00
```bash
🔥 Remove $ from code fenced examples on readme (#1435) * 🔥 Remove $ from code fenced examples on readme * 🚨 FIx markdownlint errors README.md:8: MD009 Trailing spaces README.md:10: MD009 Trailing spaces
2022-10-01 12:37:50 +02:00
http --offline pie.dev/post hello=offline
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
```
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):
Add a workflow to check documentations (#1151) * Add a workflow to check documentations * Fix markdown issues * Install Ruby 2.7 * Finally, handle and fix GitHub templates * Minor improvement in the feature request template * Verbose mode to be sure all files are checked
2021-09-09 15:52:24 +02:00
```bash
🔥 Remove $ from code fenced examples on readme (#1435) * 🔥 Remove $ from code fenced examples on readme * 🚨 FIx markdownlint errors README.md:8: MD009 Trailing spaces README.md:10: MD009 Trailing spaces
2022-10-01 12:37:50 +02:00
http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
```
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
[See more examples →](https://httpie.io/docs#examples)
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
## Community & support
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links.
Update README.md
2021-10-07 16:21:36 +02:00
- Join our [Discord server](https://httpie.io/discord) is to ask questions, discuss features, and for general API chat.
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
- 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.
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
## Contributing
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Readme tweaks (#1141)
2021-09-06 20:17:21 +02:00
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.
Switch from reStructuredText to Markdown and add `docs/` (#1139) * 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.
2021-09-06 17:36:13 +02:00
Cleanup
2021-09-06 20:19:31 +02:00
[See contribution guide →](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md)
Copy Permalink