Skip to content

Omniaevo/mqtt5-explorer

MQTT5 Explorer

Repo stars Repo watchers Repo forks

Issues Workflow status Last commit Latest release AUR License

About this project

The aim of this project is to bring the users a client app capable of making use of all the features of the version 5 of the MQTT protocol. The lack of any application that can offer the compatibility with the newer version of the protocol forced us to implement one to test the data of MQTT brokers workwise, why not to share this tool with others that may have the same issue?

NEWS! You can find a complete rewrite and redesign of MQTT5 Expolorer here. The new project is based on GoLang (using Wails) instead of Electron, the UI has been updated to Vue 3. The Go version has the starting version set to 2.0.0 but, since the new project is not complete yet and it is primarily vibe-coded (OpenCode + MiniMax M2.5), it is not intended to replace this version of the app present in this repository. We'll be glad if you want to try it and give feedbacks on the new Go version of MQTT5 Explorer!

Screenshots

Dark theme

Client screenshot (dark theme)

Light theme

Client screenshot (light theme)

Downloads

Download on Flathub

Download on AUR

Download on Github

Project setup

npm install

Compiles and hot-reloads for development

npm run electron:serve

Generate app icons

npm run electron:icons

Lints and fixes files

npm run lint

Compiles and minifies for production

N.B.: the build process includes electron publish, a .env file with the GITHUB_TOKEN environment variable set is required.

# Linux
npm run electron:build -- --linux # Without publish
npm run electron:build -- --linux -p always # With GitHub publish

# MacOS
npm run electron:build -- --mac # Without publish
npm run electron:build -- --mac -p always # With GitHub publish

# Windows
npm run electron:build -- --win # Without publish
npm run electron:build -- --win -p always # With GitHub publish

# Flatpak
# ⚠️ The flatpak and flatpak-builder packages need to be installed in order to build Flatpak bundles. ⚠️
npm run electron:build -- --linux flatpak
# Install and run the flatpak package
flatpak install --user mqtt5-explorer-[VERSION]-linux-x86_64.flatpak && flatpak run com.omniaevo.mqtt5_explorer

Customize configuration

See:

Get involved

See:

Contributors

Contributors