c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual page, bestie edition ✨

okay so you opened the c8y manual and honestly? slay. this is the whole thing, rewritten so it actually makes sense, no cap. every flag is still here, we're not skipping a single one 🫶

🌸 NAME 🌸

c8y-ui-applications-plugins — Cumulocity UI Application plugin management. that's the whole vibe: we're managing the plugins that live inside a UI application. literally it. 💖

✨ SYNOPSIS ✨

c8y ui applications plugins [flags]

🎀 DESCRIPTION 🎀

Manage the plugins which are installed in a UI application. that's it, that's the job — you're the main character in charge of what plugins are chilling inside a UI application 👑

🔥 OPTIONS 🔥

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

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these ones you didn't even have to ask for — they come from the parent command and they're just… there, like a good group chat 💜
  • --abortOnErrors=10 — abort batch when reaching specified number of errors. like, ten strikes and we're out ✋
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? iconic, not an error 🫶
  • --cache[=false] — enable cached responses 🍓
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal
  • --confirm[=false] — prompt for confirmation 🙈
  • --confirmText="" — custom confirmation text
  • --currentPage=0 — current page which should be returned
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — set very verbose log messages. it's giving "I want to see 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 ✨
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl
  • --examples[=false] — show examples for the current command 🌸
  • --filter=[] — apply a client side filter to response before returning it to the user
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested who? now it's flat, periodt 💅
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page 🔁
  • -k, --insecure[=false] — allow insecure server connections when using SSL. highkey risky, but it's your call bestie 😭
  • -l, --logMessage="" — add custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). literally the "use with caution" is right there in the original, so… caution, bestie 🚨
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting)
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. sad beige terminal 🌧️
  • --noLog[=false] — disables the activity log for the current command
  • --noProgress[=false] — disable progress bars
  • --noProxy[=false] — ignore the proxy settings
  • -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
  • --outputFile="" — save JSON output to file (after select/view)
  • --outputFileRaw="" — save raw response to file (before select/view)
  • --outputTemplate="" — jsonnet template to apply to the output
  • -p, --pageSize=5 — maximum results per page. five at a time, cozy 🎀
  • --progress[=false] — show progress bar. this will also disable any other verbose output
  • --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 💀
  • --retries=3 — max number of attempts when a failed http call is encountered. three tries, that's the rule 🍓
  • --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
  • --totalPages=0 — total number of pages to get
  • -v, --verbose[=false] — verbose logging. the way that it tells you everything 🗣️
  • --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
  • --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 is so valid, no pressure 🧚

🦋 SEE ALSO 🦋

like a little friend group of related commands, go read them too 💖

okay that's the whole page!! this one's the c8y(1) manual, and the original footer says Jan 1980 — yes, that date, iconic vintage behavior, we respect it 👑 now go manage those plugins, bestie, you're literally gonna slay 💅✨

📦 where this page comes from