https://github.com/snappey/mqtt-explorer

CLI based tool for monitoring and exploring MQTT brokers, inspired by the original MQTT Explorer
https://github.com/snappey/mqtt-explorer

bubbletea cli golang mqtt mqtt-client tui

Last synced: 18 days ago
JSON representation

CLI based tool for monitoring and exploring MQTT brokers, inspired by the original MQTT Explorer

• Host: GitHub
• URL: https://github.com/snappey/mqtt-explorer
• Owner: Snappey
• License: mit
• Created: 2023-07-02T20:07:46.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-16T19:50:22.000Z (12 months ago)
• Last Synced: 2024-12-21T22:24:39.145Z (18 days ago)
• Topics: bubbletea, cli, golang, mqtt, mqtt-client, tui
• Language: Go
• Homepage:
• Size: 1.74 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        







MQTT Explorer - CLI based MQTT client displayed in an easy to navigate tree



[![Build](https://github.com/Snappey/MQTT-Explorer/actions/workflows/go.yml/badge.svg)](https://github.com/Snappey/MQTT-Explorer/actions/workflows/go.yml)

[![Release](https://github.com/Snappey/MQTT-Explorer/actions/workflows/release.yml/badge.svg)](https://github.com/Snappey/MQTT-Explorer/actions/workflows/release.yml)



 The project is currently in early development, bugs and weirdness to be expected.













A CLI for exploring and interacting with MQTT topics, inspired by the original [MQTT-Explorer](https://mqtt-explorer.com), but brought directly into your command line. This tool enables you to navigate and view your MQTT broker's topic structure in a intuitive, tree-like format, and provides functionality to view the latest payload data and publish arbitrary messages to existing topics.

## Features

**Current:**

- Visualize your entire broker's topic structure in an interactive, navigable tree.

- View the latest and historical payloads for any given topic.

- Publish arbitrary messages to existing topics.

- Copy payloads to clipboard for easy sharing.

- Fullscreen mode for larger payloads.

**Planned:**

- Publish to arbitrary topics with customizable QoS and Retained message configurations.

- Implement search functionality and filtering capabilities for the topic structure.

- Syntax highlighting for payloads to improve readability.

- Profile support to automatically connect to saved brokers

## Installation

MQTT-Explorer can be installed using `go install` or downloading the latest binary from Releases.

```shell

go install github.com/snappey/mqtt-explorer@latest

```

## Usage

Ensure that the binary exists within your PATH, this is handled for you if `go install` is used.

```shell

mqtt-explorer [flags]

Flags:

  -h, --help              help for mqtt-explorer

      --hostname string   hostname of the broker (default "test.mosquitto.org")

      --port int          port the broker is running on, typically tcp: 1883, ssl: 8883, ws: 8083 or wss: 8084 (default 1883)

      --scheme string     protocol to use tcp, ssl, ws or wss (default "tcp")

      --topic string      topic to subscribe to on the broker (default "#")

```

### Keybinds

```shell

Q, Ctrl+C                     - Close the application

Arrow Keys                    - Move around the Tree / Select Payloads

Shift Up/Down Arrow Keys      - Skip 5

Shift Ctrl Up/Down Arrow Keys - Skip 25

HOME                          - Skip to Start

END                           - Skip to End

TAB                           - Cycle focus between each Panel

C                             - Copy the selected payload to clipboard

V                             - Paste the selected payload into publish message textarea

F                             - Toggle fullscreen mode (only available when selecting a payload)

```