https://github.com/shobrook/statcode
Man pages for HTTP status codes
https://github.com/shobrook/statcode
http-requests http-server man-page status-codes
Last synced: about 1 month ago
JSON representation
Man pages for HTTP status codes
- Host: GitHub
- URL: https://github.com/shobrook/statcode
- Owner: shobrook
- License: mit
- Created: 2018-06-27T04:26:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-19T04:40:46.000Z (over 4 years ago)
- Last Synced: 2025-03-29T19:06:12.848Z (about 2 months ago)
- Topics: http-requests, http-server, man-page, status-codes
- Language: Python
- Homepage:
- Size: 2.01 MB
- Stars: 312
- Watchers: 10
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# statcode
`statcode` is like `man` but for HTTP status codes. If you're a web developer, you probably spend some time looking at response codes (usually errors) and then Googling what they mean. But with `statcode`, you can simply run `$ statcode [status_code]` and get a quick explanation of your HTTP response without leaving the terminal.
## Installation
>Requires Python 3.0 or higher
`statcode` works on MacOS, Linux, and Windows (if you use Cygwin). You can install it with pip:
```bash
$ pip install statcode
```
Or if you're running Arch, you can install [`statcode`](https://aur.archlinux.org/packages/statcode/) from the AUR:
```bash
$ aurman -S statcode
```
## Contributing
This is a pretty small project (something I put together on a plane ride), but with enough help it could turn into a go-to manual for everything HTTP-related. For example, it should be possible to look up different [request headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers), e.g. running `$ statcode cache-control` and getting "Specifies directives for caching mechanisms in both requests and responses." If you'd like to help make this happen, feel free to fork the repo and contribute.
If you've discovered a bug or have a feature request, create an [issue](https://github.com/shobrook/statcode/issues/new) and I'll take care of it!