c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual, but make it make sense 🫶

okay so bestie, you opened the manual page for c8y — and more specifically for the c8y-firmware-versions command — and it's giving "wall of flags" energy 😭. don't panic. i got you. this is literally the same page, same facts, just with the vibes fixed. no cap, nothing dropped. ✨

🌸 NAME 🌸

c8y-firmware-versions — Cumulocity firmware version management. that's the whole name. iconic, lowkey self-explanatory. 👑

🦋 SYNOPSIS 🦋

c8y firmware versions [flags]

that's it. that's the invocation. c8y, then firmware, then versions, then whatever flags your heart desires. 💖

🎀 DESCRIPTION 🎀

Firmware version management to create/list/delete versions. so like — you've got firmware versions in Cumulocity, and this command is the main character that manages them: creating them, listing them, deleting them. that's the vibe check, she passed. 💅

✨ OPTIONS ✨

her own personal options (there's literally one, and honestly? she's thriving):

  • -h, --help[=false] — help for versions. that's it, that's the flag, and it's the moment. 🫶

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay so this is the long part. these all come from the parent commands, so they show up here too. buckle up bestie, we're going through all of them, no skipping, periodt. 💀

  • --abortOnErrors=10 — abort batch when reaching specified number of errors. so after 10 oopsies, she's out. 👋
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? no drama. 🌸
  • --cache[=false] — enable cached responses. make it snappy. ⭐
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values. iykyk. 🧚
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. she expires, respectfully. ⏳
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal. 💅
  • --confirm[=false] — prompt for confirmation. consent era. 🙈
  • --confirmText="" — custom confirmation text. make it your own. ✍️
  • --currentPage=0 — current page which should be returned. page zero, we start at zero. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. get creative. 🎨
  • --debug[=false] — set very verbose log messages. VERY verbose. she will not shut up and that's the point. 🔍
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. ✋
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. same energy, opposite timing. ✋
  • --dry[=false] — dry run. don't send any data to the server. window shopping only. 🛍️
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. pick your aesthetic. 🎀
  • --examples[=false] — show examples for the current command. queen behavior, show me how it's done. 👑
  • --filter=[] — apply a client side filter to response before returning it to the user. sift it before it reaches you. 🫧
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore. flattened. 🥞
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. bold of you. 🔥
  • -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. ⚠️ it says what it says, bestie, proceed with awareness.
  • -l, --logMessage="" — add custom message to the activity log. leave your little note. 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). yeah that caution is fr fr, don't be reckless. 💀
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. 🚫
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). no cache, no exceptions. 🙅
  • -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. shh. 🤫
  • --noProgress[=false] — disable progress bars. no bars, just vibes. 🚫
  • --noProxy[=false] — ignore the proxy settings. 🚪
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. life saver in loops, ngl. 🔁
  • -o, --output="table" — output format i.e. table, json, csv, csvheader. pick your medium. 🎨
  • --outputFile="" — save JSON output to file (after select/view). 📁
  • --outputFileRaw="" — save raw response to file (before select/view). raw and unfiltered. 📁
  • --outputTemplate="" — jsonnet template to apply to the output. ✨
  • -p, --pageSize=5 — maximum results per page. five at a time, cute little portions. 🍓
  • --progress[=false] — show progress bar. this will also disable any other verbose output. ⏳
  • --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. raw is raw. 🥩
  • --retries=3 — max number of attempts when a failed http call is encountered. she tries three times, that's grace. 🔁
  • --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). hi peter. 👋
  • --silentExit[=false] — silent status codes do not affect the exit code. 🤐
  • --silentStatusCodes="" — status codes which will not print out an error message. quiet ones. 🤐
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. she waits, but not forever. ⏰
  • --totalPages=0 — total number of pages to get. 📚
  • -v, --verbose[=false] — verbose logging. tell me everything. 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. 🖥️
  • --withError[=false] — errors will be printed on stdout instead of stderr. plot twist, the error's on the main stage now. 😭
  • --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. one worker, doing her best, or more if you say so. 🛠️

💜 SEE ALSO 💜

the whole firmware friend group, go say hi. 🫶

okay that's the entire page, nothing skipped, nothing invented — and yeah, this manual page lives proudly under the name c8y(1), dated Jan 1980 (yes, literally Jan 1980, she's vintage and she's still serving 💅🎀). byeee, go manage those firmware versions bestie, you're gonna slay. 🌈⭐💖

📦 where this page comes from