c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) — c8y-scripts: Script Utilities, Bestie Edition 💖

okay so you're looking at the manual page for c8y scripts — that's part of the c8y(1) command suite — and it's literally all about processing and formatting shell scripts. I'm obsessed already. Let's get into it. 🫶

🌸 NAME 🌸

c8y-scripts — Script utilities. That's the whole vibe. 💅

🦋 SYNOPSIS 🦋

c8y scripts [flags]

🎀 DESCRIPTION 🎀

Utilities for processing and formatting shell scripts. It's giving "I just want my scripts to look cute and actually work" energy. ✨

✨ OPTIONS ✨

  • -h, --help[=false] — shows you this help text for the scripts command, bestie.

🔥 OPTIONS INHERITED FROM PARENT COMMANDS 🔥

  • --abortOnErrors=10 — aborts the whole batch once it reaches the specified number of errors. Default is 10.
  • --allowEmptyPipe[=false] — doesn't fail when the piped input is empty (stdin). So if you pipe in literally nothing, it won't break on you.
  • --cache[=false] — enables cached responses so you're not re-fetching the same stuff over and over.
  • --cacheBodyPaths=[] — limits which paths in the json body get hashed for the cache. An empty array (the default) means all values get hashed.
  • --cacheTTL="60s" — the cache's time-to-live (TTL) as a duration — like 60s or 2m. Default is 60s.
  • -c, --compact[=false] — compacts the output instead of pretty-printing it when you're using json output. Fun fact: pretty print is the default if the output is going to your terminal.
  • --confirm[=false] — prompts you to confirm before doing the thing.
  • --confirmText="" — lets you write your own custom confirmation text instead of the default one.
  • --currentPage=0 — tells it which page you actually want back. Default is 0.
  • --customQueryParam=[] — lets you add your own custom URL query params, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
  • --debug[=false] — turns on super verbose log messages so you can see everything that's happening.
  • --delay="0ms" — waits this long after each request. It's a duration, so like 5ms or 1.2s. Default is 0ms.
  • --delayBefore="0ms" — waits this long before each request. Duration, so like 5ms or 1.2s. Default is 0ms.
  • --dry[=false] — dry run mode! It literally doesn't send any data to the server, it just shows you what would happen.
  • --dryFormat="markdown" — the format for dry run output — can be json, dump, markdown, or curl. Default is markdown.
  • --examples[=false] — shows you examples for whatever command you're currently running.
  • --filter=[] — applies a client-side filter to the response before it even gets to you.
  • --flatten[=false] — flattens json output by replacing nested json properties with properties where their names are represented by dot notation.
  • -f, --force[=false] — skips the confirmation prompt and just does the thing. But heads up: it's ignored when you're using --confirm.
  • -H, --header=[] — lets you add custom headers, like --header 'Accept: value, AnotherHeader: myvalue'.
  • --includeAll[=false] — grabs all the results by iterating through every single page.
  • -k, --insecure[=false] — allows insecure server connections when you're using SSL. Literally what it says on the tin, so know what you're doing.
  • -l, --logMessage="" — adds your own custom message into the activity log.
  • --maxJobs=0 — max number of jobs to run. 0 means unlimited — and the original literally says "(use with caution!)" so I'm telling you: use with caution, bestie. Default is 0.
⚠️ 0 = unlimited jobs. The manpage itself is like "use with caution!" and honestly same energy. Don't come for me if your machine starts crying. 😭
  • --noAccept[=false] — removes the Accept header from requests. But careful: only PUT and POST requests will actually see the effect.
  • --noCache[=false] — forces cached responses OFF. It overwrites whatever your cache setting was.
  • -M, --noColor[=false] — turns off colors when log entries are shown on the console.
  • --noLog[=false] — disables the activity log for the command you're running right now.
  • --noProgress[=false] — turns off progress bars.
  • --noProxy[=false] — ignores your proxy settings.
  • -n, --nullInput[=false] — doesn't read the input (stdin). Super useful when you're using it in shell for or while loops.
  • -o, --output="table" — sets the output format — like table, json, csv, or csvheader. Default is table.
  • --outputFile="" — saves the JSON output to a file. Important: this happens after select/view.
  • --outputFileRaw="" — saves the raw response to a file. Important: this happens before select/view.
  • --outputTemplate="" — applies a jsonnet template to the output.
  • -p, --pageSize=5 — max number of results you get per page. Default is 5.
  • --progress[=false] — shows a progress bar. Warning: this also disables any other verbose output.
  • --proxy="" — sets your proxy, like http://10.0.0.1:8080.
  • -r, --raw[=false] — shows the raw response. This mode forces output=json and view=off.
  • --retries=3 — how many times to retry when an http call fails. Default is 3.
  • --select=[] — a comma-separated list of properties you want back. Wildcards and globstar are accepted, like --select 'id,name,type,**.serialNumber'.
  • --session="" — session config stuff.
  • --sessionMode="" — overrides the default session mode for just this one command — the mode that would normally be disabled.
  • -P, --sessionPassword="" — overrides the session password.
  • -U, --sessionUsername="" — overrides the session username. Like peter or t1234/peter (with tenant).
  • --silentExit[=false] — makes it so silent status codes do not affect the exit code.
  • --silentStatusCodes="" — status codes that will not print out an error message.
  • --timeout="600s" — how long before a request times out. It's a duration like 60s or 2m. Default is 600s.
  • --totalPages=0 — how many total pages to grab. Default is 0.
  • -v, --verbose[=false] — turns on verbose logging.
  • --view="auto" — uses views when displaying data on the terminal. To turn it off: --view off. Default is auto.
  • --withError[=false] — makes errors print on stdout instead of stderr.
  • --withTotalElements[=false] — asks Cumulocity to include the total elements in the response statistics under .statistics.totalElements — this was introduced in 10.13.
  • -t, --withTotalPages[=false] — asks Cumulocity to include the total pages in the response statistics under .statistics.totalPages.
  • --workers=1 — number of workers to use. Default is 1.

🌈 SEE ALSO 🌈

and that's a wrap on c8y scripts, bestie! 🎀 this page is from the c8y(1) manual, dated Jan 1980, and you can always check the SEE ALSO for more. mwah, love you, bye! 💖🫶✨

📦 where this page comes from