c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the Cumulocity CLI, realtime edition 🛰️

okay bestie, you're looking at the c8y manual page — specifically the realtime corner of it — and honestly? it's giving "powerful tool, zero hand-holding." so let's break it down together, no cap. 🫶

✨ NAME ✨

c8y-realtime — Cumulocity realtime notifications. that's the whole vibe. it's realtime, it's notifications, it's Cumulocity. periodt. 💖

🎀 SYNOPSIS 🎀

c8y realtime [flags]

that's it. c8y realtime, plus whatever flags you're feeling. main character energy fr. ✨

🌸 DESCRIPTION 🌸

Cumulocity realtime notifications. yep — that's literally the description, she's a woman of few words and honestly? iconic. this is the doorway to the realtime stream, and the actual subscribing happens in the commands below (see SEE ALSO, babes). 💅

💜 OPTIONS 💜

  • -h, --help[=false] — help for realtime. yes, the classic. whenever you're lost, just ask for help, she's there. 🥺

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay so this is the big one — every single one of these comes from the parent command, so they work here too. buckle up, bestie, there are a LOT and we're going through all of them. 🔥

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. so if things go sideways 10 times, she's out. default is 10.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). no input? no drama. 🍓
  • --cache[=false] — Enable cached responses. memory queen.
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. so [] means hash literally everything.
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default lives at "60s".
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. so she's pretty until you tell her not to be.
  • --confirm[=false] — Prompt for confirmation. a little "u sure tho?" moment. 🙈
  • --confirmText="" — Custom confirmation text. make the "u sure tho?" say whatever you want.
  • --currentPage=0 — Current page which should be returned. default 0.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. go off, add whatever params you want.
  • --debug[=false] — Set very verbose log messages. she will NOT stop talking. 💀
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default "0ms".
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default "0ms". before AND after, she's thorough.
  • --dry[=false] — Dry run. Don't send any data to the server. window shopping only, no buying. 🛍️
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. default "markdown".
  • --examples[=false] — Show examples for the current command. love a tutorial moment. ✨
  • --filter=[] — Apply a client side filter to response before returning it to the user.
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore bestie.
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. she's assertive. 💅
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] — Include all results by iterating through each page. all of them. every last one.
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. ⚠️ yeah that's exactly what it sounds like — careful out there.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). the caution is theirs, not mine, but like… caution. 😭
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. read that again, it's specific.
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). cache? never heard of her.
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. monochrome moment. 🖤
  • --noLog[=false] — Disables the activity log for the current command.
  • --noProgress[=false] — Disable progress bars.
  • --noProxy[=false] — Ignore the proxy settings.
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. lifesaver fr.
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. default "table".
  • --outputFile="" — Save JSON output to file (after select/view).
  • --outputFileRaw="" — Save raw response to file (before select/view). before vs after — know the difference, bestie.
  • --outputTemplate="" — jsonnet template to apply to the output.
  • -p, --pageSize=5 — Maximum results per page. default 5.
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. it's her or the chatter, not both.
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080.
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. no filter, no edits, just vibes.
  • --retries=3 — Max number of attempts when a failed http call is encountered. default 3. she tries again. 🥺
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
  • --session="" — Session configuration.
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled.
  • -P, --sessionPassword="" — Override session password. 🔐
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant).
  • --silentExit[=false] — Silent status codes do not affect the exit code.
  • --silentStatusCodes="" — Status codes which will not print out an error message.
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. default "600s".
  • --totalPages=0 — Total number of pages to get. default 0.
  • -v, --verbose[=false] — Verbose logging.
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. default "auto".
  • --withError[=false] — Errors will be printed on stdout instead of stderr. plot twist.
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13).
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages.
  • --workers=1 — Number of workers. default 1, but like… you could have more. 👀

🦋 SEE ALSO 🦋

go read these next, bestie, they're the whole point:

and that's the page!! mwah 💋 this little doc is brought to you by the c8y(1) manual — dated Jan 1980 (yes, actual vintage, she's been serving since forever 🎀) — from the c8y(1) corner of the manual. now go subscribe to something and slay. 💖✨

📦 where this page comes from