AIOCOAP-CLIENT(1)

📦
version 0.4.17 · 4 versions
, in ubuntu stonking

👑 aiocoap-client(1) — the aiocoap manual's main character

okay so bestie, listen. aiocoap-client is a simple command-line tool for interacting with CoAP servers, and it lives in the aiocoap manual (section 1, obviously, she's a user command 💅). It's how you go query CoAP servers from your terminal like the icon you are. No cap.

✨ SYNOPSIS ✨

usage: aiocoap-client [-h] [-v] [-q] [--version] [--interactive] [--color]
                      [--pretty-print] [--proxy URI]
                      [--credentials CREDENTIALS] [--no-set-hostname] [--non]
                      [-m METHOD] [--observe] [--observe-exec CMD]
                      [--accept MIME] [--payload X]
                      [--payload-initial-szx SZX] [--content-format MIME]
                      url

🎀 POSITIONAL ARGUMENTS 🎀

  • url — the CoAP address you wanna fetch. That's the whole vibe. Give her the address, she goes and gets it. 🦋

🌸 NAMED ARGUMENTS 🌸

  • -v, --verbose — turn the debug output UP. more words, more detail, more chaos. 🔥
  • -q, --quiet — turn the debug output DOWN. shhh. quiet hours. 🤫
  • --version — shows the program's version number and then exits, like a queen leaving the group chat. 👑
  • --interactive — drop into interactive mode. Pro tip from me to you: combine it with --help, or just run help interactively, to see which options apply where — because some of these can be set globally and then overwritten locally. Default: False.
  • --color, --no-color — colorize the output. (Default: on for TTYs, but only if all the required modules are installed. no modules, no rainbow, sorry bestie 🌈)
  • --pretty-print, --no-pretty-print — pretty-print known content formats. (Default: on for TTYs, again only if all the required modules are installed. ✨)
  • --proxy — relay the CoAP request to a proxy and let it do the executing. outsourcing, iconic behavior. 🫶
  • --credentials — load the credentials you want to use from a given file.
  • --no-set-hostname — suppresses transmission of Uri-Host even when the host name isn't an IP literal. Default: True.
  • --non — send the request as a non-confirmable (NON) message. Default: False.
  • -m, --method — the name or the number of the request method you wanna use (default: 'GET'). Default: 'GET'.
  • --observe — register an observation on the resource. she's WATCHING. 👀 Default: False.
  • --observe-exec — run the program you specify every single time the observed resource changes, feeding the response data straight into its stdin. obsessed. 💖
  • --accept — the content format to request.
  • --payload — send X as the request payload (eg. with a PUT). And here's the cute part: if X starts with an '@', the rest of it is treated as a file name and read from that file — and '@-' reads from the console instead. Non-file data may get recoded, so peek at --content-format for that.
  • --payload-initial-szx — size exponent to limit the initial block's size (0 ≙ 16 Byte, 6 ≙ 1024 Byte).
  • --content-format — the content format of the --payload data. If a known format is given and --payload has a non-file argument, the payload gets converted from CBOR Diagnostic Notation. yes really. 🧚

Christian Amsüss and the aiocoap contributors. give them their flowers. 💐

ngl, that's the whole page, bestie. go forth and CoAP. 😭💅

0.4 — dated Apr 04, 2026 — that's a wrap on AIOCOAP-CLIENT(1), from the aiocoap era, and yes she ate. periodt. 🍓✨

📦 where this page comes from