c8y(1)

🎀 NAME 🎀

okay so bestie, this is the manual page for c8y(1) — and the icon of this specific page is c8y-template, aka Template utilities. it’s literally giving “tiny utility, big main character energy” 💅.

✨ SYNOPSIS ✨

c8y template [flags]

the whole vibe: you call c8y template and toss your flags at it 🦋.

🦋 DESCRIPTION 🦋

Template utilities, fr fr. you use these to test out the templating language without sending any data to Cumulocity. no cap — zero data goes to the server, it’s just here so you can try stuff out ✨.

💖 OPTIONS 💖

• -h, --help[=false] — help for template. the little helper, periodt.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are inherited from the parent commands, so they show up here like hand-me-downs but make it iconic. every single one, no skipping:

• --abortOnErrors=10 — abort the batch when reaching the specified number of errors. default is 10.
• --allowEmptyPipe[=false] — don’t fail when piped input is empty (stdin). lowkey handy.
• --cache[=false] — enable cached responses. yes bestie, cache.
• --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. clock it.
• -c, --compact[=false] — compact instead of pretty-printed output when using json output; pretty print is the default if output is the terminal. slay formatting.
• --confirm[=false] — prompt for confirmation. be safe bestie.
• --confirmText="" — custom confirmation text. make it yours 💅.
• --currentPage=0 — current page which should be returned.
• --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. exact code, no edits.
• --debug[=false] — set very verbose log messages. it’s giving spill the tea.
• --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. zero data, zero drama.
• --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl.
• --examples[=false] — show examples for the current command. we love a demo.
• --filter=[] — apply a client side filter to response before returning it to the user. filtered, periodt.
• --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested but make it flat.
• -f, --force[=false] — do not prompt for confirmation; ignored when using --confirm. heads up: --confirm wins.
• -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 vibes.
• -k, --insecure[=false] — allow insecure server connections when using SSL. careful bestie, insecure is literally in the name.
• -l, --logMessage="" — add custom message to the activity log. leave your mark.
• --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). fr fr, caution.
• --noAccept[=false] — ignore Accept header; this removes the Accept header from requests, however PUT and POST requests will only see the effect. only PUT and POST catch the effect.
• --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. monochrome moment.
• --noLog[=false] — disables the activity log for the current command. quiet luxury.
• --noProgress[=false] — disable progress bars. no bar, no stress.
• --noProxy[=false] — ignore the proxy settings. proxy who?.
• -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. pick your aesthetic.
• --outputFile="" — save JSON output to file (after select/view). save it for later.
• --outputFileRaw="" — save raw response to file (before select/view). raw and unfiltered.
• --outputTemplate="" — jsonnet template to apply to the output. template inception.
• -p, --pageSize=5 — maximum results per page. default is 5.
• --progress[=false] — show progress bar; this will also disable any other verbose output. progress bar takes the mic.
• --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 mode is a whole commitment.
• --retries=3 — max number of attempts when a failed http call is encountered. default is 3.
• --select=[] — comma separated list of properties to return; wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. exact example, bestie.
• --session="" — session configuration. session lore.
• --sessionMode="" — override default session mode for a single command which would normally be disabled. one-command override.
• -P, --sessionPassword="" — override session password. secret secret.
• -U, --sessionUsername="" — override session username, i.e. peter or t1234/peter (with tenant). tenant included, iykyk.
• --silentExit[=false] — silent status codes do not affect the exit code. exit code stays unbothered.
• --silentStatusCodes="" — status codes which will not print out an error message. quiet errors.
• --timeout="600s" — request timeout duration, i.e. 60s, 2m. respect the clock.
• --totalPages=0 — total number of pages to get. page count era.
• -v, --verbose[=false] — verbose logging. tell me everything.
• --view="auto" — use views when displaying data on the terminal; disable using --view off. auto view, off switch included.
• --withError[=false] — errors will be printed on stdout instead of stderr. stdout era for errors.
• --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). introduced in 10.13, noted.
• -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. total pages, total slay.
• --workers=1 — number of workers. default is 1.

💅 SEE ALSO 💅

• c8y(1)
• c8y-template-execute(1)

and that’s the whole page, bestie 🫶 this iconic little manual is from c8y(1), dated Jan 1980 — bye, love you, mwah 💋