c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y-operations-assert — bestie's guide to operation assertions 💅

okay so real quick, we're in the c8y(1) manual page — that's the Cumulocity CLI, and this particular little corner of it is all about operation assertions. welcome, you're gonna do great 🫶

✨ NAME ✨

c8y-operations-assert — Operation assertions

like, it asserts stuff about operations. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

c8y operations assert [flags]

that's it. that's the whole thing you type. no cap.

🦋 DESCRIPTION 🦋

Assertions related to Cumulocity operations 💖

(ngl that's all the manpage gives us here — it's a short one. it's giving "minimalist icon" energy. the parent command c8y-operations has the lore, this is the little sibling.)

🎀 OPTIONS 🎀

these are this command's own flags, bestie:

  • -h, --help[=false] — help for assert. yes it's just help text. yes you still need it. 😭

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

okay this is the big one — literally everything below gets handed down from the parent command, so you get all of it for free. no gatekeeping here 💜

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. like, it bails after this many oopsies.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? not a whole crisis. 🙈
  • --cache[=false] — Enable cached responses. save yourself a round trip ✨
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values.
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m.
  • -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 checks, we love to see it 🫶
  • --confirmText="" — Custom confirmation text.
  • --currentPage=0 — Current page which should be returned.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — Set very verbose log messages. maximum yapping, but like, diagnostically 🔥
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s.
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s.
  • --dry[=false] — Dry run. Don't send any data to the server. window shopping mode 🛍️
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] — Show examples for the current command.
  • --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.
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. (yes, --confirm wins. it's the main character here 👑)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — Include all results by iterating through each page.
  • -k, --insecure[=false] — Allow insecure server connections when using SSL.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). ⚠️ literally caution, it says so
  • --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).
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console.
  • --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.
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader.
  • --outputFile="" — Save JSON output to file (after select/view).
  • --outputFileRaw="" — Save raw response to file (before select/view).
  • --outputTemplate="" — jsonnet template to apply to the output.
  • -p, --pageSize=5 — Maximum results per page.
  • --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.
  • --retries=3 — Max number of attempts when a failed http call is encountered.
  • --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.
  • --totalPages=0 — Total number of pages to get.
  • -v, --verbose[=false] — Verbose logging.
  • --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.
  • --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.
ok bestie, quick vibe check: there are a lot of flags here and they all do genuinely different things. don't just mash them. read the label. iykyk 💀

🔥 SEE ALSO 🔥

go read the parent, she raised this command 💖 and assert-count is the sibling who literally just counts. iconic behavior.

that's the whole page, bestie — no crumbs left behind 🎀

sign-off szn: this gem is from the c8y(1) manual, dated Jan 1980 (yes, really, that's the date on the tin 😭 — retro queen behavior), and it's the c8y page you just read. mwah 💋 slay, go assert some operations ✨🦋

📦 where this page comes from