c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the manual page, but make it group chat

okay so bestie, welcome to c8y(1) — the Cumulocity CLI, and more specifically the measurements corner of it. this page is literally your cheat sheet. no cap, every flag is here, nothing skipped, so let's go 🎀

✨ NAME ✨

c8y-measurements — Cumulocity measurements 💖 like, the whole measurements thing. that's the vibe.

🦋 SYNOPSIS 🦋

c8y measurements [flags]

that's it. that's the whole entrance. flags are the whole personality.

🌸 DESCRIPTION 🌸

so this one is a REST endpoint to interact with Cumulocity measurements ✨ it's the measurements main character, and all the little subcommands (create, list, delete, subscribe, all of them) are its supporting cast 🫶

💅 OPTIONS 💅

  • -h, --help[=false] — help for measurements. the classic "what does this do again" button, iconic 💫

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

okay so these are the flags you get for free from the parent command — the nepo babies of the flag world, and honestly they ate 💀

  • --abortOnErrors=10 — abort the batch once you hit this many errors. like a "babe, that's enough" limit.
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. be chill about it.
  • --cache[=false] — enable cached responses 🍓
  • --cacheBodyPaths=[] — cache should limit hashing to selected paths in the json body. empty means all values (so, hash literally everything).
  • --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. and lowkey pretty print is the default if output is the terminal ✨
  • --confirm[=false] — prompt for confirmation. are you sure, bestie?
  • --confirmText="" — custom confirmation text, for when you want to ask in your own words 🎀
  • --currentPage=0 — the 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. the "tell me everything" mode 🗣️
  • --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. fake it till you make it 🙈
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl
  • --examples[=false] — show examples for the current command. tutorial mode 🧚
  • --filter=[] — apply a client side filter to the 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 💅
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. (so --confirm wins, always.)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page. get the WHOLE thing.
  • -k, --insecure[=false] — allow insecure server connections when using SSL. 👀 careful babe.
  • -l, --logMessage="" — add a custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) 🔥
  • --noAccept[=false] — ignore Accept header. this 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 the cache setting).
  • -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 🌀
  • -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. no filter, no makeup, raw footage 🎥
  • --retries=3 — max number of attempts when a failed http call is encountered. try again bestie, you got this.
  • --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. tell me MORE.
  • --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. hire more if you're feeling brave 💪

🌈 SEE ALSO 🌈

your little family tree, go explore bestie:

okay that's the whole page, you're officially a measurements scholar 👑💜 and yeah — this beauty is dated Jan 1980, the og timestamp, see you next time bestie, slay ✨💅

📦 where this page comes from