c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y-util glow-up

okay bestie, you're looking at c8y(1), and this is the page for the general utilities situation — the little helper corner of c8y you'll be combining with all your other c8y commands. yes, it's giving "supporting cast" but honestly? supporting cast with main character energy. let's go 🎀

✨ NAME ✨

c8y-util — General utilities. that's it, that's the whole name. short, sweet, iconic. 🦋

✨ SYNOPSIS ✨

c8y util [flags]

literally just that. c8y util plus whatever flags you're feeling. no notes. 👑

✨ DESCRIPTION ✨

General utilities for combining with other c8y commands. so like — this is the glue, the lil toolbox, the thing you reach for when you want to build bigger stuff out of the other commands. no cap, it's a team player. 🫶

✨ OPTIONS ✨

okay so here's the local squad — the flags that belong to util itself:

  • -h, --help=[false] — help for util. the classic. when in doubt, ask for help. 💖

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

now THIS is the section. these are the flags that come down from the parent command — the whole heirloom collection. every single one, no skipping, because we don't do that here. 🌸

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. like, if 10 things go wrong, bestie, we're stopping. 🛑
  • --allowEmptyPipe=[false] — Don't fail when piped input is empty (stdin). empty pipe? no drama. 💅
  • --cache=[false] — Enable cached responses. reuse & recycle ✨
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. like, narrow it down if you want, or don't. 🎀
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. how long your cached stuff stays fresh, fr fr. ⏳
  • -c, --compact=[false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. so like, pretty when you're on the terminal, compact when you're piping. slay. 🔥
  • --confirm=[false] — Prompt for confirmation. yes, it wants a lil "are you sure?" moment. 🙈
  • --confirmText="" — Custom confirmation text. make it say whatever you want. 👑
  • --currentPage=0 — Current page which should be returned. page zero, baby. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. yes, it's comma-separated. yes, it's exact. 🌈
  • --debug=[false] — Set very verbose log messages. VERY verbose. like, "why is it telling me all this" verbose. use it when you're stuck tho, lowkey lifesaver. 💀
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. be polite to the server. 🧚
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. same energy, but earlier. ⏱️
  • --dry=[false] — Dry run. Don't send any data to the server. rehearse, don't commit. 🎭
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. pick your flavor. ⭐
  • --examples=[false] — Show examples for the current command. yes bestie, there are examples, go look. 📚
  • --filter=[] — Apply a client side filter to response before returning it to the user. sift it before it hits you. 💖
  • --flatten=[false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested stuff becomes like.this. 🦋
  • -f, --force=[false] — Do not prompt for confirmation. Ignored when using --confirm. bold move, but noted. 💅
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". 🎀
  • --includeAll=[false] — Include all results by iterating through each page. all the pages, all the results. 🌸
  • -k, --insecure=[false] — Allow insecure server connections when using SSL. ⚠️ insecure is literally in the name — know what you're doing.
  • -l, --logMessage="" — Add custom message to the activity log. leave your lil signature. ✍️
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). like, the caution is theirs, not mine, but I'm passing it along verbatim bestie. 🔥
  • --noAccept=[false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. that's the whole deal, exactly as written. 👀
  • --noCache=[false] — Force disabling of cached responses (overwrites cache setting). cache? not today. 🚫
  • -M, --noColor=[false] — Don't use colors when displaying log entries on the console. for the monochrome girlies. 🖤
  • --noLog=[false] — Disables the activity log for the current command. 🌙
  • --noProgress=[false] — Disable progress bars. no lil 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. genuinely so useful. 💡
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. pick your aesthetic. 🌈
  • --outputFile="" — Save JSON output to file (after select/view). 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). ⚠️ note the "before" — it's different from --outputFile, don't mix 'em up.
  • --outputTemplate="" — jsonnet template to apply to the output. fancy. 🎨
  • -p, --pageSize=5 — Maximum results per page. five. by default. 🤏
  • --progress=[false] — Show progress bar. This will also disable any other verbose output. ⚠️ it's a trade-off, bestie — progress bar in, verbose out.
  • --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. it's not asking, it's telling. 💀
  • --retries=3** — Max number of attempts when a failed http call is encountered. three strikes energy. 🔁
  • --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. ten whole minutes by default, generous queen. ⏰
  • --totalPages=0 — Total number of pages to get. 📚
  • -v, --verbose=[false] — Verbose logging. the chattier sibling of --debug. 🗣️
  • --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: errors go to stdout 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 by default, one worker doing their best. 💪

🌈 SEE ALSO 🌈

go read these too, they're the friend group:

okay that's the whole page bestie, you ate this 💅 genuinely — this was c8y(1) from Jan 1980, and yes the date is sending me too but that's what the page says so that's what we're putting. 🎀✨ love you, go combine some commands 🫶

📦 where this page comes from