https://github.com/gcaaa31928/socket-cli

CLI with auto completion and syntax highlighting for socket.io, websocket and unix socket . ALL IN ONE
https://github.com/gcaaa31928/socket-cli

socket-io socket-io-client unix-sock websock

Last synced: 2 months ago
JSON representation

CLI with auto completion and syntax highlighting for socket.io, websocket and unix socket . ALL IN ONE

• Host: GitHub
• URL: https://github.com/gcaaa31928/socket-cli
• Owner: gcaaa31928
• Created: 2019-10-28T17:22:42.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-07T12:29:44.000Z (about 5 years ago)
• Last Synced: 2024-03-15T06:48:43.452Z (10 months ago)
• Topics: socket-io, socket-io-client, unix-sock, websock
• Language: Python
• Homepage:
• Size: 39.1 KB
• Stars: 21
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Welcome to socket-cli 👋



  

  

  



> A command-line client for socket.io, websocket, unix-socket that has auto-completion and syntax highlighting.

## ✨ Demo

### Just take a look

[![asciicast](https://asciinema.org/a/GgXCsrUEhlY98xxlrhIQcRpNj.svg)](https://asciinema.org/a/GgXCsrUEhlY98xxlrhIQcRpNj?speed=2)

## 🚀 Usage

install *socket-cli* via pip:

```bash

pip install socket-cli

```

```bash

Usage: socket-cli [OPTIONS] [PATH]

Options:

  -t, --type TEXT  [websocket, socketio, unix]

  --help           Show this message and exit.

````

when you connect a socket.io server.

```bash

> connect

> emit --event event_name --data '{"test": "data"}'

> on --event event_name

> on --event event_name --namespace /admin

> emit --event event_name --data '{"test": "data"}' --namespace /admin

```

or a websocket server

```bash

> connect

> send --data test

> recv 

```

or a unix socket server

```bash

> connect

> send --data test

```

```bash

> connect

> send --data 

> on --event event_name

```

## 🤝 Contributing

Contributions, issues and feature requests are welcome.


Feel free to check [issues page](https://github.com/gcaaa31928/socket-cli/issues) and pull-request welcome.

## TODO

- [ ] connect socket.io server with headers

- [ ] unit-testing, ci

## Author

👤 **gcaaa31928**

* Website: http://gcaaa.blogspot.tw/

* Github: [@gcaaa31928](https://github.com/gcaaa31928)

## Show your support

Give a ⭐️ if this project helped you!

***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_