https://github.com/ecthiender/websocket-inspector

Simple TUI client for debugging websocket communication
https://github.com/ecthiender/websocket-inspector

Last synced: 8 months ago
JSON representation

Simple TUI client for debugging websocket communication

• Host: GitHub
• URL: https://github.com/ecthiender/websocket-inspector
• Owner: ecthiender
• License: bsd-3-clause
• Created: 2020-07-24T00:42:08.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-08T06:44:18.000Z (about 3 years ago)
• Last Synced: 2025-02-01T07:23:08.907Z (over 1 year ago)
• Language: Haskell
• Size: 4.53 MB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# websocket-inspector

A simple Haskell TUI to inspect and debug websocket communication. This is a interactive (TUI) websockets client, which can be used to interactively debug websocket communication with a websocket server.

The program is written using the excellent [brick](https://hackage.haskell.org/package/brick) library.

### Usage

```shell

websocket-inspector --url ws://echo.websocket.org/

```

```shell

websocket-inspector --url "wss://gateway.discord.gg/?v=6&encoding=json"

```

### Demo

[![demo](https://asciinema.org/a/352853.png)](https://asciinema.org/a/352853)

![demo-gif](media/websocket-inspector-demo.GIF)

### How to run it

I have not worked on generating the binary on releases, so you would have to build it on your computer.

- Clone the repo

- Make sure you have [stack](https://docs.haskellstack.org/en/stable/README/) installed

- `cd` into this directory and run `stack install`. This will copy the `websocket-inspector` binary into your `PATH`.