c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay so bestie, welcome to c8y(1) 💖 this is the manual page for the c8y command-line tool, and today's main character is the c8y-ui-plugins-delete subcommand. it's giving "delete a UI plugin from your tenant" energy and honestly? iconic. let's get into it 🎀

✨ NAME ✨

c8y-ui-plugins-delete — Delete UI plugin 💅

🦋 SYNOPSIS 🦋

c8y ui plugins delete [flags]

like, that's the whole vibe. command, subcommand, subcommand, and then whatever flags you feel like adding ✨

🌸 DESCRIPTION 🌸

okay so fr fr what this does: it deletes an existing UI plugin from the tenant. that's it, that's the whole thing. it's a delete command, so be normal about it — she does not undo 😭

🔥 OPTIONS 🔥

here's the main-character flag list for the delete command itself 🫶

  • -h, --help[=false] — help for delete. classic, always there for you 💖
  • --id="" — the plugin, and heads up it's required. also accepts pipeline input, so you can pipe it in like a boss 🎀
  • --processingMode="" — the Cumulocity processing mode. yes bestie, that one 🌈

🌟 OPTIONS INHERITED FROM PARENT COMMANDS 🌟

okay this is the big one. these all come from the parent commands, meaning you get them for free whether you asked or not. no cap, here's every single one 👑

  • --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. she's tolerant like that 🙈
  • --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 the output is the terminal 💅
  • --confirm[=false] — prompt for confirmation 🙋‍♀️
  • --confirmText="" — custom confirmation text, for when you want your own words ✍️
  • --currentPage=0 — the 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. she's chatty 🗣️
  • --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 you 🔍
  • --flatten[=false] — flatten json output by replacing nested json properties with properties whose 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. careful with that one bestie 😬
  • -l, --logMessage="" — add a custom message to the activity log 🪵
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) — and yes, that caution is in the original, so like, be careful 💀
  • --noAccept[=false] — ignore the Accept header, which removes 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 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 📑
  • --progress[=false] — show the 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 the 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 🧚

okay so here's the moment you've been waiting for, a real live example 🎬

$ c8y ui plugins delete --id "my-example-app"

and that deletes it — Remove UI plugin 💅✨

💜 SEE ALSO 💜

and that's the whole page bestie 🌈 that was c8y(1), rendered from source/version c8y(1) and dated Jan 1980 — yes, Jan 1980, the manpage is a vintage icon and we respect her 👑💖 mwah, go delete some plugins responsibly 🎀

📦 where this page comes from