https://github.com/byteclubfr/socket.io-monitor-cli

CLI client for socket.io-monitor
https://github.com/byteclubfr/socket.io-monitor-cli

socket-io

Last synced: 9 days ago
JSON representation

CLI client for socket.io-monitor

• Host: GitHub
• URL: https://github.com/byteclubfr/socket.io-monitor-cli
• Owner: byteclubfr
• License: mit
• Created: 2017-05-04T09:16:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-06T09:34:12.000Z (about 7 years ago)
• Last Synced: 2024-10-11T02:41:22.818Z (about 1 month ago)
• Topics: socket-io
• Language: JavaScript
• Size: 34.2 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# socket.io-monitor-cli

CLI client for socket.io-monitor

This dashboard displays real-time information about your running socket.io server:

- events log

- sockets list

- rooms list

## Installation

```sh

npm install -g socket.io-monitor-cli

```

## Usage

First, enable [socket.io-monitor](https://github.com/byteclubfr/socket.io-monitor) in your socket.io server.

```sh

socket.io-monitor [--port port] [--host addr] [--password pwd]

Options:

  --host, -h      Server address                 [string] [default: "localhost"]

  --port, -p      Server port                            [number] [defaut: 9042]

  --password, -a  Password (if not provided but server requires one, you will be

                  interactively asked for one)            [string] [default: ""]

  --help          Display help                                         [boolean]

```

## Development

The terminal rendering is made with [react-blessed](https://github.com/Yomguithereal/react-blessed).

Therefore, using `console.log` in the source will mix your debug output with the rendered app.

So, prefer `console.error` and redirect `stderr`:

```sh

socket.io-monitor 2> debug.log

```

```sh

tail -f debug.log

```