Scroll to navigation

AIOCOAP-CLIENT(1) aiocoap AIOCOAP-CLIENT(1)

NAME

aiocoap-client - query CoAP servers from the command line

aiocoap-client is a simple command-line tool for interacting with CoAP servers

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

CoAP address to fetch

NAMED ARGUMENTS

Increase the debug output
Decrease the debug output
show program's version number and exit
Enter interactive mode. Combine with --help or run help interactively to see which options apply where; some can be used globally and overwritten locally.

Default: False

Color output (default on TTYs if all required modules are installed)
Pretty-print known content formats (default on TTYs if all required modules are installed)
Relay the CoAP request to a proxy for execution
Load credentials to use from a given file
Suppress transmission of Uri-Host even if the host name is not an IP literal

Default: True

Send request as non-confirmable (NON) message

Default: False

Name or number of request method to use (default: 'GET')

Default: 'GET'

Register an observation on the resource

Default: False

--observe-exec
Run the specified program whenever the observed resource changes, feeding the response data to its stdin
Content format to request
Send X as request payload (eg. with a PUT). If X starts with an '@', its remainder is treated as a file name and read from; '@-' reads from the console. Non-file data may be recoded, see --content-format.
--payload-initial-szx
Size exponent to limit the initial block's size (0 ≙ 16 Byte, 6 ≙ 1024 Byte)
Content format of the --payload data. If a known format is given and --payload has a non-file argument, the payload is converted from CBOR Diagnostic Notation.

COPYRIGHT

Christian Amsüss and the aiocoap contributors

April 3, 2025 0.4