c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y — the c8y ui plugins create page, but make it make sense

okay bestie, welcome to c8y(1) — specifically the corner of the manual that covers c8y-ui-plugins-create, which is a whole mouthful, i know. it's the page you want when you're about to shove a UI plugin at your tenant and you'd rather not do it blind 🫶

✨ NAME ✨

c8y-ui-plugins-create — create or update a UI plugin and its version 🎀

like, literally that's the whole job. you give it a file, it gives you a plugin. slay.

✨ SYNOPSIS ✨

c8y ui plugins create [flags]

that's it. that's the vibe. flags are where all the drama lives 💀

✨ DESCRIPTION ✨

So the actual deal: this command creates a new UI plugin, or if it already exists, it updates the binary of that existing UI plugin. new plugin, old plugin, doesn't matter — you're covered ✨

🚨 notes, and this one is important bestie — if the file you pass in has a space in the filename, it gets copied to a temp location first and the spaces get replaced with underscores. why? because otherwise the server will straight up reject the file upload 😭 so like... it handles it for you, but now you know why things look weird in /tmp.

🌸 OPTIONS 🌸

  • --availability="" — access level for other tenants. possible values are MARKET, SHARED, PRIVATE (and PRIVATE is the default, no cap)
  • --contextPath="" — the contextPath of the hosted application. required when the application type is HOSTED ⚠️
  • -d, --data=[] — static data to be applied to the body. takes json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' 💖
  • --file="" — the UI plugin file to be uploaded, this is the main character honestly 👑
  • -h, --help[=false] — help for create (the classic)
  • --key="" — shared secret of the application 🔐
  • --name="" — name of the application
  • --processingMode="" — Cumulocity processing mode
  • --resourcesUrl="" — URL to the application base directory hosted on an external server. required when the application type is HOSTED ⚠️
  • --tag=[] — tags. include 'latest' to change the activeVersionId of the application ⭐
  • --template="" — body template
  • --templateVars=[] — body template variables
  • --version="" — plugin version 🎀

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

yes there are this many. no i'm not skipping any. we're doing this together bestie, hold my hand 🫶

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty
  • --cache[=false] — enable cached responses
  • --cacheBodyPaths=[] — cache should limit hashing to selected paths in the json body. empty means 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 🐛
  • --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 the 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 a custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution! ⚠️)
  • --noAccept[=false] — ignore the Accept header, which 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 the 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 the 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 🎀

real examples, copy-paste-able, the whole thing 💖

$ c8y ui plugins create --file ./myapp.zip --tag latest
Create new ui plugin from a file and tag it as the latest

create a new ui plugin straight from a file and tag it as the latest. iconic.

$ c8y ui plugins create --name my-plugin --file ./myapp.zip
Create or update a ui plugin using an explicit name

create or update a ui plugin using an explicit name. this is the "i know what i'm doing" one.

$ c8y ui plugins create --file ./myapp.zip --name my-plugin --version 1.0.0 --tag latest --tag stable-v1
Create/update a ui plugin and override the name and version

create/update a ui plugin and override the name and the version. tag it twice, why not — you get latest and stable-v1 🔥

$ c8y ui plugins create --file "https://github.com/SoftwareAG/cumulocity-remote-access-cloud-http-proxy/releases/download/v2.5.0/cloud-http-proxy-ui.zip"
Create/update a ui plugin from a URL

and yes bestie, it takes a URL too. create/update a ui plugin from a URL, no local file required. ate. 👑

⭐ SEE ALSO ⭐

okay that's the whole page! and before you close the tab — this one's c8y(1), dated Jan 1980 (yes, really, the manpage dating is a whole mood 💀). consider this your cute lil' sign-off — now go upload that plugin, you've got this 🦋✨ 🌈

📦 where this page comes from