https://github.com/hivemq/mqtt-cli

MQTT CLI is a useful command line interface for connecting various MQTT clients supporting MQTT 5.0 and 3.1.1
https://github.com/hivemq/mqtt-cli

cli iot java mqtt mqtt-client

Last synced: 3 days ago
JSON representation

MQTT CLI is a useful command line interface for connecting various MQTT clients supporting MQTT 5.0 and 3.1.1

• Host: GitHub
• URL: https://github.com/hivemq/mqtt-cli
• Owner: hivemq
• License: apache-2.0
• Created: 2019-04-05T10:34:03.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T09:41:48.000Z (3 months ago)
• Last Synced: 2024-10-18T03:45:57.761Z (3 months ago)
• Topics: cli, iot, java, mqtt, mqtt-client
• Language: Java
• Homepage: https://hivemq.github.io/mqtt-cli/
• Size: 15.1 MB
• Stars: 314
• Watchers: 25
• Forks: 47
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        








[![GitHub Release](https://img.shields.io/github/v/release/hivemq/mqtt-cli?style=for-the-badge)](https://github.com/hivemq/mqtt-cli/releases)

[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/hivemq/mqtt-cli/.github/workflows/check.yml?branch=master&style=for-the-badge)](https://github.com/hivemq/mqtt-cli/actions/workflows/check.yml?query=branch%3Amaster)

[![CLI Downloads](https://img.shields.io/github/downloads/hivemq/mqtt-cli/total?style=for-the-badge)](https://github.com/hivemq/mqtt-cli/releases)

[![CLI License](https://img.shields.io/github/license/hivemq/mqtt-cli?style=for-the-badge)](https://github.com/hivemq/mqtt-cli/blob/develop/LICENSE)

mqtt-cli is a feature-rich MQTT Command Line Interface.






[Getting Started](#getting-started) •

[Publish](#publish) •

[Subscribe](#subscribe) •

[Shell](#shell) •

[Test](#test) •

[How to Contribute](#how-to-contribute)



## Getting Started

- [Installation instructions](https://hivemq.github.io/mqtt-cli/docs/installation/) 

- [Building from source](https://hivemq.github.io/mqtt-cli/docs/installation/#building-from-source) 

- [Full documentation](https://hivemq.github.io/mqtt-cli)

## Publish

- Publish a message

- Quick start: `mqtt pub -t your-topic -m "your message" -h your-mqtt-broker.com`

- [Further documentation](https://hivemq.github.io/mqtt-cli/docs/publish/) 



## Subscribe

- Subscribe to topics and receive output directly on the console

- Quick start: `mqtt sub -t your-topic -h your-mqtt-broker.com`

- [Further documentation](https://hivemq.github.io/mqtt-cli/docs/subscribe/)



## Shell

- Enter the mqtt-cli shell mode to access more MQTT functionality

- Quick start: `mqtt sh`

- [Further documentation](https://hivemq.github.io/mqtt-cli/docs/shell/)



## Test

- Run tests against a broker to find out its features and limitations

- Quick start: `mqtt test -h your-mqtt-broker.com`

- [Further documentation](https://hivemq.github.io/mqtt-cli/docs/test/)



## How to Contribute

- If you want to request a feature or report a bug, please [create a GitHub Issue using one of the provided templates](https://github.com/hivemq/mqtt-cli/issues/new/choose)

- If you want to make a contribution to the project, please have a look at the [contribution guide](CONTRIBUTING.md)