An open API service indexing awesome lists of open source software.

https://github.com/schroedinger-hat/cattp

A CLI tool to understand HTTP codes and cats
https://github.com/schroedinger-hat/cattp

Last synced: 5 months ago
JSON representation

A CLI tool to understand HTTP codes and cats

Awesome Lists containing this project

README

        



[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]




cattp




Logo




Explore the docs »




View Demo
·
Report Bug
·
Request Feature


Table of Contents



  1. About The Project


  2. Usage

  3. Contributing

  4. Contact

## About The Project

### Tech stack

This is built in `rust`

## Installation

### Install it with Homebrew

```
brew tap Schrodinger-Hat/cattp https://github.com/Schrodinger-Hat/cattp
brew update
brew install cattp
```

### Updating it with Homebrew

Sometimes Homebrew will not upgrade your package directly with `brew update && brew upgrade`. That's not a problem.
Just `brew cleanup && brew uninstall cattp && brew install cattp` if that's the case. Or you can delete the file mismatch if you feel
that you want to do that and then just run `brew upgrade`

### Install it manually

Unzip the `cattp.tar.gz` and `mv` the executable so that it can be found in your `$PATH` variable.

```
mv cattp /usr/local/bin/

chmod +x /usr/local/bin/cattp

cattp
```

### Build it

Install `rust` on your systems. Run `cargo install --path [a path of your choice]`.

## Usage

```
Usage: cattp [OPTIONS]

Arguments:

Options:
-d, --description
-n, --no-open
-e, --explain
-h, --help Print help
-V, --version Print version
```

_example_
`cattp 404 -d`
`cattp 404 -n`
`cattp 404 -e`

You can even use more flags together
`cattp 404 -den`

The console will output the status code and also open your system's web browser if `o` flag is present.

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

## Contact

Schrodinger's Hat Team - [@schrodinger_hat](mailto:[email protected])

Project Link: [https://github.com/Schrodinger-Hat/cattp](https://github.com/Schrodinger-Hat/cattp)

[contributors-shield]: https://img.shields.io/github/contributors/Schrodinger-Hat/cattp.svg?style=for-the-badge
[contributors-url]: https://github.com/Schrodinger-Hat/cattp/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Schrodinger-Hat/cattp.svg?style=for-the-badge
[forks-url]: https://github.com/Schrodinger-Hat/cattp/network/members
[stars-shield]: https://img.shields.io/github/stars/Schrodinger-Hat/cattp?style=for-the-badge
[stars-url]: https://github.com/Schrodinger-Hat/cattp/stargazers
[issues-shield]: https://img.shields.io/github/issues/Schrodinger-Hat/cattp.svg?style=for-the-badge
[issues-url]: https://github.com/Schrodinger-Hat/cattp/issues