Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add EdJoPaTo/mqttui #18125

Merged
merged 1 commit into from Dec 12, 2023

Conversation

CrystalMethod
Copy link
Contributor

EdJoPaTo/mqttui: Subscribe to a MQTT Topic or publish something quickly from the terminal

$ aqua g -i EdJoPaTo/mqttui

How to confirm if this package works well

Reviewers aren't necessarily familiar with this package, so please describe how to confirm if this package works well.
Please confirm if this package works well yourself as much as possible.

Command and output

$ mqttui --help
Subscribe to a MQTT Topic or publish something quickly from the terminal

Usage: mqttui [OPTIONS] [TOPIC]... [COMMAND]

Commands:
  clean-retained
          Clean retained messages from the broker [aliases: c, clean]
  log
          Log values from subscribed topics to stdout [aliases: l]
  read-one
          Wait for the first message on the given topic(s) and return its payload to stdout [aliases: r, read]
  publish
          Publish a value quickly [aliases: p, pub]
  help
          Print this message or the help of the given subcommand(s)

Arguments:
  [TOPIC]...
          Topic to watch

          [env: MQTTUI_TOPIC=]
          [default: #]

Options:
  -b, --broker <URL>
          URL which represents how to connect to the MQTT broker.

          Examples: `mqtt://localhost` `mqtt://localhost:1883` `mqtts://localhost` `mqtts://localhost:8883` `ws://localhost/path`
          `ws://localhost:9001/path` `wss://localhost/path` `wss://localhost:9001/path`

          [env: MQTTUI_BROKER=]
          [default: mqtt://localhost]

  -u, --username <STRING>
          Username to access the mqtt broker.

          Anonymous access when not supplied.

          [env: MQTTUI_USERNAME=]

      --password <STRING>
          Password to access the mqtt broker.

          Consider using a connection with TLS to the broker. Otherwise the password will be transported in plaintext.

          Passing the password via command line is insecure as the password can be read from the history! You should pass it via environment
          variable.

          [env: MQTTUI_PASSWORD]

  -i, --client-id <STRING>
          Specify the client id to connect with

          [env: MQTTUI_CLIENTID=]

      --client-cert <FILEPATH>
          Path to the TLS client certificate file.

          Used together with --client-key to enable TLS client authentication. The file has to be a DER-encoded X.509 certificate serialized to PEM.

          [env: MQTTUI_CLIENT_CERTIFICATE=]

      --client-key <FILEPATH>
          Path to the TLS client private key.

          Used together with --client-cert to enable TLS client authentication. The file has to be a DER-encoded ASN.1 file in PKCS#8 form
          serialized to PEM.

          [env: MQTTUI_CLIENT_PRIVATE_KEY=]

      --insecure
          Allow insecure TLS connections

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

[EdJoPaTo/mqttui](https://github.com/EdJoPaTo/mqttui): Subscribe to a MQTT Topic or publish something quickly from the terminal
@suzuki-shunsuke suzuki-shunsuke added the enhancement New feature or request label Dec 12, 2023
@suzuki-shunsuke suzuki-shunsuke added this to the v4.102.0 milestone Dec 12, 2023
@suzuki-shunsuke
Copy link
Member

Thank you!

@suzuki-shunsuke suzuki-shunsuke merged commit 075148f into aquaproj:main Dec 12, 2023
16 checks passed
@suzuki-shunsuke
Copy link
Member

@CrystalMethod CrystalMethod deleted the feat/EdJoPaTo/mqttui branch December 18, 2023 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants