c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — bestie's guide to the Cumulocity CLI

okay so real talk: this is the c8y(1) manual page, and we're zooming all the way in on one little corner of it. your girl knows her way around a terminal, so trust me when I say this page is actually useful and you're gonna slay it 🫶

✨ NAME ✨

c8y-ui-applications — Cumulocity UI Applications

like, that's the whole name, that's the assignment 💖

🦋 SYNOPSIS 🦋

c8y ui applications [flags]

that's it. that's the invocation. flags optional, confidence mandatory ✨

🌸 DESCRIPTION 🌸

Managed UI Applications.

short, sweet, and to the point — this command lives in the "managed UI applications" part of the Cumulocity universe and it's giving main character energy 👑

🎀 OPTIONS 🎀

  • -h, --help[=false] — help for applications. yes bestie, the classic. when in doubt, ask for help 💅

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the flags that trickle down from the parent command, and there are so many of them. buckle up babes, we're going through every single one 🌈

  • --abortOnErrors=10 — abort the batch once you hit this many errors. no cap, ten strikes and the whole thing just stops 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. so when your pipe gives you nothing, it just shrugs instead of throwing hands 🙈
  • --cache[=false] — enable cached responses. reusing is literally self-care ✨
  • --cacheBodyPaths=[] — the cache should limit hashing to the selected paths in the json body. empty means all values get hashed 🍓
  • --cacheTTL="60s" — cache time-to-live (TTL), written as a duration, i.e. 60s, 2m. so it's giving "how long is this snack good for" ⏳
  • -c, --compact[=false] — compact instead of pretty-printed output when you're using json output. plot twist though: pretty print is the default if the output is the terminal 🖥️
  • --confirm[=false] — prompt for confirmation. yes, it will literally ask you first, consent is iconic 🫶
  • --confirmText="" — custom confirmation text, for when you want the prompt to say your words 💬
  • --currentPage=0 — the current page that should be returned 📄
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' — go off, customize your little heart out 🔥
  • --debug[=false] — set very verbose log messages. she's loud, she's chatty, she's telling you everything 🗣️
  • --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. all the vibes, none of the consequences 😌
  • --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 the response before returning it to the user. sift out the noise before it reaches you 🧚
  • --flatten[=false] — flatten json output by replacing nested json properties with properties whose names are represented by dot notation. nested? not anymore, bestie 🪄
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. so --confirm wins the argument, periodt 💅
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
  • --includeAll[=false] — include all results by iterating through each page. every last one, no crumbs left behind 🍪
  • -k, --insecure[=false] — allow insecure server connections when using SSL. careful bestie, this one's spicy 🌶️
  • -l, --logMessage="" — add a custom message to the activity log ✍️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). the manpage literally said caution, so like... caution ⚠️
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. read that one twice, it's doing a lot 🙃
  • --noCache[=false] — force disabling of cached responses (overwrites the cache setting). cache said no ❌
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. sad beige logging for sad beige times 🎨
  • --noLog[=false] — disables the activity log for the current command 🚫
  • --noProgress[=false] — disable progress bars. no bar, no drama 📉
  • --noProxy[=false] — ignore the proxy settings 🙅
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. she does not want your input, respectfully 🔇
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader 📊
  • --outputFile="" — save JSON output to a file (after select/view) 💾
  • --outputFileRaw="" — save the raw response to a file (before select/view) 💾
  • --outputTemplate="" — jsonnet template to apply to the output 🧩
  • -p, --pageSize=5 — maximum results per page. five at a time, like lil snack portions 🍓
  • --progress[=false] — show a progress bar. this will also disable any other verbose output. it's giving focus mode 🎯
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080 🌐
  • -r, --raw[=false] — show the raw response. this mode will force output=json and view=off — no filter, no glam, just raw 🪞
  • --retries=3 — max number of attempts when a failed http call is encountered. she tries three times, she's persistent like that 💪
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' 🎯
  • --session="" — session configuration 🔑
  • --sessionMode="" — override the default session mode for a single command, which would normally be disabled 🔄
  • -P, --sessionPassword="" — override the session password. keep it secret, keep it safe 🤫
  • -U, --sessionUsername="" — override the session username, i.e. peter or t1234/peter (with tenant) 👤
  • --silentExit[=false] — silent status codes do not affect the exit code. hush hush 🤐
  • --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. she's telling you everything and honestly? we're listening 👂
  • --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. moving the error to the other stream, iconic 🔀
  • --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, but she can absolutely bring friends 👯

🔥 SEE ALSO 🔥

go read those too, iykyk 💜

that's the whole page babes, no notes 🌟 this one's from the c8y(1) manual, dated Jan 1980 — yes, the footer really is that vintage, and honestly? retro icon behavior 🕰️💖

📦 where this page comes from