c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual page, but make it make sense

okay bestie so you opened the manual for c8y and honestly? we're gonna get through this together. this is the "install UI plugins in an application" glow-up, and yes the NAME line is a whole mouthful: c8y-ui-applications-plugins-install. say it three times fast, i dare you. 🫶

✨ NAME ✨

c8y-ui-applications-plugins-install — install UI plugins in an application. that's the whole vibe. it does exactly what it says on the tin, no cap. 💖

🌸 SYNOPSIS 🌸

c8y ui applications plugins install [flags]

like, that's it. that's the doorway. flags are optional, the energy is mandatory. 🎀

🦋 DESCRIPTION 🦋

Install UI plugins in an application. short, sweet, iconic queen behaviour. it takes your plugins and puts them in your app. periodt. 🔥

🎀 OPTIONS 🎀

these are the flags that belong to this command, the main-character flags if you will:

  • --application="" — the application you're installing into. it's required, bestie, no skipping it — and yes it accepts a pipeline ✨
  • -d, --data=[] — static data to be applied to body. it accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' 🍓
  • -h, --help[=false] — help for install. the "wait what does this do again" button 💀
  • --plugin=[] — UI plugin to be installed. give it plugins, it gives you slay 🌈
  • --processingMode="" — Cumulocity processing mode
  • --template="" — body template
  • --templateVars=[] — body template variables

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

okay so these are the flags you didn't ask for but got anyway, passed down like good genes. all of them, no gatekeeping:

  • --abortOnErrors=10 — abort batch when reaching specified number of errors
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? not a crisis 💜
  • --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. for when you need to know 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
  • -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
  • -l, --logMessage="" — add custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) 🚨
  • --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
  • --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
  • --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
  • --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
  • --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

⭐ EXAMPLE ⭐

okay the examples are lowkey the best part, look at these:

$ c8y ui applications plugins install --application devicemanagement --plugin myplugin@latest --plugin someother@1.2.3
Install multiple UI plugins to the devicemanagement application

multiple plugins, one command. the efficiency. the grace. 🧚

$ c8y ui applications plugins install --application devicemanagement --plugin myplugin --template "{config:{remotes:{'other@1.0.0':[]}}}"
Install myplugin via a lookup and add manual configuration using templates (for power users only!)
bestie, that second one says "for power users only!" in the actual docs. it's not me being dramatic. proceed with main character energy but, like, responsibly. 💀

🌈 SEE ALSO 🌈

and that's the whole page, bestie. go install some plugins, you're gonna eat 💅✨

— with love, from the c8y manual, dated Jan 1980 (yes fr fr, iconic vintage) 🎀

📦 where this page comes from