https://github.com/leozz37/jaguar

🐆 CLI tool for testing socket connections
https://github.com/leozz37/jaguar

Last synced: 16 days ago
JSON representation

🐆 CLI tool for testing socket connections

• Host: GitHub
• URL: https://github.com/leozz37/jaguar
• Owner: leozz37
• License: mit
• Created: 2020-11-13T06:42:16.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-06-13T12:50:18.000Z (over 2 years ago)
• Last Synced: 2024-05-15T13:07:06.042Z (8 months ago)
• Language: Rust
• Homepage:
• Size: 27.3 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jaguar 🐆

[![CodeFactor](https://www.codefactor.io/repository/github/leozz37/jaguar/badge)](https://www.codefactor.io/repository/github/leozz37/jaguar)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2b0fc19ee70e48588b060555026834a1)](https://www.codacy.com/gh/leozz37/jaguar/dashboard?utm_source=github.com&utm_medium=referral&utm_content=leozz37/jaguar&utm_campaign=Badge_Grade)

![Build](https://github.com/leozz37/jaguar/workflows/Build/badge.svg)

[![Documentation](https://codedocs.xyz/leozz37/jaguar.svg)](https://codedocs.xyz/leozz37/jaguar/)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Jaguar is a simple tool for working with socket connections. You can send, listen and ping a port using your terminal.

## Installing

You can install using [homebrew](https://brew.sh/):

```shell

$ brew tap leozz37/jaguar

$ brew install jaguar

```

## Running

You can use the `--help` command to check all the options:

| Argument       | Description                    | Required | Default   |

| -------------- | ------------------------------ | -------- | --------- |

| -l, --listen   | Listen to a socket port        | No       | False     |

| -s, --send     | Send payload to a socket port  | No       | False     |

| -a, --alive    | Ping a port                    | No       | True      |

| -p, --port     | Port to be interacted with     | Yes      | -         |

| -h, --hostname | Hostname to be interacted with | No       | 127.0.0.1 |

| -d, --data     | Payload to be sent             | No       | -         |

You can run it with `cargo` to install all its dependencies:

```shell

$ jaguar -p 3000

```

### Listen

To listen to a socket connection, run the following command:

```shell

$ jaguar -l -p 3000

```

To listen to a custom hostname, use the `-h` flag:

```shell

$ jaguar -l -p 3000 -h "127.0.0.1"

```

### Send

To send a payload to a socket connection, run the following command:

```shell

$ jaguar -s -p 3000 -d "Hello World"

```

To listen to a custom hostname, use the `-h` flag:

```shell

$ jaguar -s -p 3000 -d "Hello World" -h "127.0.0.1"

```

### Ping

To ping a socket connection, run the following command:

```shell

$ jaguar -p 3000

```

The `-a` flag is optional, ping is the default action of Jaguar.

### About

Made with ❤️ by [leozz37](https://www.linkedin.com/in/leonardoaugustolima/)!