{"id":18974895,"url":"https://github.com/mqtt-tools/mqttshark","last_synced_at":"2025-04-19T16:44:13.117Z","repository":{"id":136937861,"uuid":"603244762","full_name":"mqtt-tools/mqttshark","owner":"mqtt-tools","description":"MQTT formatter for tshark, the terminal network packet capture tool.","archived":false,"fork":false,"pushed_at":"2024-05-08T21:52:07.000Z","size":185,"stargazers_count":18,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-29T10:23:30.555Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mqtt-tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-17T23:35:42.000Z","updated_at":"2024-08-30T14:30:29.000Z","dependencies_parsed_at":"2024-04-26T12:52:59.812Z","dependency_job_id":null,"html_url":"https://github.com/mqtt-tools/mqttshark","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mqtt-tools%2Fmqttshark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mqtt-tools%2Fmqttshark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mqtt-tools%2Fmqttshark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mqtt-tools%2Fmqttshark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mqtt-tools","download_url":"https://codeload.github.com/mqtt-tools/mqttshark/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249223949,"owners_count":21232836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T15:16:38.324Z","updated_at":"2025-04-16T09:34:19.653Z","avatar_url":"https://github.com/mqtt-tools.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mqttshark - MQTT formatter for tshark\n\nmqttshark will run tshark, the terminal network packet capture tool, and\nattempt to pretty print any MQTT messages received.\n\nIt can decode MQTT packets tunnelled over WebSockets, and can decode TLS\npackets when pre-keys are available.\n\nmqttshark requires at least Python 3.6, and possibly something more recent than\nthat. It also requires tshark to be installed.\n\n## Usage\n\nRun listening to port 1883 on the first non-loopback network interface:\n\n```\nmqttshark\n# Run a test\nmosquitto_sub -h test.mosquitto.org -t '$SYS/broker/uptime' -t sub-2 -U unsub-1 -U unsub-2 \\\n\t-q 2 -V 5 --will-topic will-topic --will-payload payload\n```\n\n![example output](example.png)\n\nRun on a specific network interface:\n```\nmqttshark -i eth0\n```\n\nFurther examples:\n\n```\nmqttshark -p 1234:mqtt # Listen on port 1234, decoding as MQTT\nmqttshark -p 1234:mqtts --tls-keylog \u003cfile\u003e # Listen on port 1234, decoding as MQTT over TLS.\nmqttshark -p 1234:ws # Listen on port 1234, decoding as WebSockets\nmqttshark -p 1234:mqtts --tls-keylog \u003cfile\u003e # Listen on port 1234, decoding as MQTT over WebSockets over TLS.\nmqttshark -p 1883:mqtt,8883:mqtts,8080:ws,8081:wss # Listen on multiple ports\n```\n\nThere are lots of ways of choosing how to display the output and suppress /\npick which packets to display, see the help:\n```\nmqttshark -h\n```\n\n## Display\n\nThis explains the meaning of some of the output:\n\n![display output](details.png)\n\n\n## Bugs\n\n* Will properties are not displayed - this seems to be a missing feature in tshark\n* Payloads with new lines may cause problems\n\n## Contact\n\nhttps://github.com/mqtt-tools/mqttshark\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmqtt-tools%2Fmqttshark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmqtt-tools%2Fmqttshark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmqtt-tools%2Fmqttshark/lists"}