c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y-ui-plugins — Cumulocity UI Plugins 💅

okay bestie, so this page is literally all about c8y-ui-plugins — the Cumulocity UI Plugins command. it's giving "I manage plugins and I'm iconic" energy. let's get into it ✨

🌸 SYNOPSIS 🌸

c8y ui plugins [flags]

🎀 DESCRIPTION 🎀

Managed UI Plugins. that's the whole vibe — it's here to handle your UI plugin situation, no cap. 💖

✨ OPTIONS ✨

  • -h, --help[=false] — shows help for plugins. use it when you're like "wait what does this do again?" 🙈

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the ones you get from the parent command — they're like the family traits you didn't ask for but lowkey need. 💅

  • --abortOnErrors=10 — abort batch when reaching the specified number of errors. default is 10, so it's like "bestie, if it goes wrong 10 times, we're out." 💀
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). because sometimes the pipe is empty and that's valid, fr fr. 🫶
  • --cache[=false] — enable cached responses. slay for speed. ⚡
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values. so if you leave it empty, it hashes everything — main character energy. 🌈
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default is 60s. it's giving "fresh but not too fresh." 🍓
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal. so if you want it cute and readable, do nothing; if you want it squished, use this. 💅
  • --confirm[=false] — prompt for confirmation. it's the "are you sure bestie?" of flags. 🙈
  • --confirmText="" — custom confirmation text. make it say whatever you want. iconic. 🎀
  • --currentPage=0 — current page which should be returned. default is 0. pagination vibes. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. literally add your own query params, go off. 🔥
  • --debug[=false] — set very verbose log messages. for when you need to see everything. not me debugging at 2am 😭
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default is 0ms. breathe between requests, queen. 🧚
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default is 0ms. a little pre-game pause. 💜
  • --dry[=false] — dry run. don't send any data to the server. it's the "just looking, not touching" mode. 👀
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. default is markdown. choose your fighter. 💖
  • --examples[=false] — show examples for the current command. because sometimes you need inspo. ✨
  • --filter=[] — apply a client side filter to response before returning it to the user. like a little sieve for your data. 🦋
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. it's giving "no more nesting, we're flat now." 🌸
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. it's the "I said what I said" flag. 💅
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". add your own headers, go wild. 🎀
  • --includeAll[=false] — include all results by iterating through each page. all the pages, bestie. all of them. 📚
  • -k, --insecure[=false] — allow insecure server connections when using SSL. it's risky and it knows it. use with caution, babe. ⚠️
  • -l, --logMessage="" — add custom message to the activity log. leave a little note for future you. 💌
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). so 0 means no cap, but the manpage literally warns you, so maybe don't go feral? 😭
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. it's giving "I don't accept your Accept header." 💀
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). cache? never heard of her. 🙅‍♀️
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. for when you want it plain and simple. no aesthetic today. 🖤
  • --noLog[=false] — disables the activity log for the current command. shhh, no logging. 🤫
  • --noProgress[=false] — disable progress bars. sometimes you don't want the little bar, you just want the result. periodt. 🌈
  • --noProxy[=false] — ignore the proxy settings. no middleman for you. 🚫
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. it's the "I'm not listening" flag. 🙉
  • -o, --output="table" — output format i.e. table, json, csv, csvheader. default is table. pick your vibe. 💅
  • --outputFile="" — save JSON output to file (after select/view). so you can keep it forever. 💾
  • --outputFileRaw="" — save raw response to file (before select/view). the unfiltered truth. 📁
  • --outputTemplate="" — jsonnet template to apply to the output. fancy formatting, iykyk. ✨
  • -p, --pageSize=5 — maximum results per page. default is 5. small bites, bestie. 🍰
  • --progress[=false] — show progress bar. this will also disable any other verbose output. it's giving "watch me work." 👑
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. route it through, if you must. 🌐
  • -r, --raw[=false] — show raw response. this mode will force output=json and view=off. no filter, no frills. 💀
  • --retries=3 — max number of attempts when a failed http call is encountered. default is 3. try, try, try again. 🔁
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. choose your own adventure. 🎀
  • --session="" — session configuration. the session details, bestie. 🛂
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. one-command wonder. 🌟
  • -P, --sessionPassword="" — override session password. keep it secret, keep it safe. 🤫
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant). who dis? 👤
  • --silentExit[=false] — silent status codes do not affect the exit code. quiet exit, no drama. 🚪
  • --silentStatusCodes="" — status codes which will not print out an error message. some errors are just not worth the noise. 🤐
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. default is 600s. patience is a virtue. ⏳
  • --totalPages=0 — total number of pages to get. default is 0. how many pages? all the pages. 📖
  • -v, --verbose[=false] — verbose logging. tell me everything, bestie. 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. default is auto. it's giving "I'll decide for you." 💅
  • --withError[=false] — errors will be printed on stdout instead of stderr. redirect the drama to stdout. 😭
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). fancy stats, version 10.13 and up. 📊
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. more stats, more power. 📈
  • --workers=1 — number of workers. default is 1. it's a whole team. 👯‍♀️

🔗 SEE ALSO 🔗

these are the besties you should also check out. go read them, they're iconic too. 💖

alright besties, that's the whole manual, no cap. this page is literally from c8y(1) and the footer says it's from Jan 1980 (yes, really, it's giving vintage 😭). stay slay, and remember: read the manpage before you run the command, periodt. 💅✨

📦 where this page comes from