Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sterchelen/hssp
CLI to avoid remembering the http status codes
https://github.com/sterchelen/hssp
cli http
Last synced: about 2 months ago
JSON representation
CLI to avoid remembering the http status codes
- Host: GitHub
- URL: https://github.com/sterchelen/hssp
- Owner: sterchelen
- License: gpl-3.0
- Created: 2022-05-13T18:40:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-30T00:27:02.000Z (about 1 year ago)
- Last Synced: 2024-06-19T00:20:39.398Z (3 months ago)
- Topics: cli, http
- Language: Go
- Homepage:
- Size: 25.4 KB
- Stars: 123
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hssp
[](https://justforfunnoreally.dev)
hssp for Http StatuS where the two capitals S replace the two ts of `http`.
## Why?
This CLI is here to help you find/remember the meaning of an http status code.
Historically speaking, this tool was written after struggling with my memory to find the meaning of a code.
Some tools already exist but installing Node.js is too much for me...
## Installation
### From source
To install hssp, first you need to install the dependencies:
* Arch Linux
```bash
pacman -S go make
```
Then, run:
```bash
make build
make install
```
## Quick start
### Code
```bash
$ hssp code --help
This command displays the description for the given http code
with its corresponding class and its RFC.
Usage:
hssp code CODE [...] [flags]
Flags:
-h, --help help for code
```
#### Meaning of 204
```bash
$ hssp code 204
+------+------------+-------------+---------+
| CODE | CLASS | DESCRIPTION | RFC |
+------+------------+-------------+---------+
| 204 | Successful | No Content | RFC7231 |
+------+------------+-------------+---------+
```
### Class
```bash
$ hssp class --help
This command displays the list of http status codes corresponding
to the given class, which may be specified as a number (1-5),
a class category string (1xx, 2xx, 3xx, 4xx, 5xx),
or the class name, i.e. informational, successful, redirect, clienterror,
or servererror
Usage:
hssp class [CLASS | NAME] [...] [flags]
Flags:
-h, --help help for class
```
#### List of status codes for the Successful class
```bash
$ hssp class 2
+------+------------+-------------------------------+---------+
| CODE | CLASS | DESCRIPTION | RFC |
+------+------------+-------------------------------+---------+
| 200 | Successful | OK | RFC7231 |
| 201 | Successful | Created | RFC7231 |
| 202 | Successful | Accepted | RFC7231 |
| 203 | Successful | Non-Authoritative Information | RFC7231 |
| 204 | Successful | No Content | RFC7231 |
| 205 | Successful | Reset Content | RFC7231 |
| 206 | Successful | Partial Content | RFC7231 |
| 207 | Successful | Multi-Status | RFC4918 |
| 208 | Successful | Already Reported | RFC5842 |
| 226 | Successful | IM Used | RFC3229 |
+------+------------+-------------------------------+---------+
```
## Contribution
No other words than "Welcome guys" :)