c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🦋 c8y(1) — the Cumulocity UI commands era ✨

okay so bestie, you've stumbled into c8y(1), which is the manual page for the Cumulocity CLI. this page is specifically about the UI side of things, and honestly it's giving "small but mighty". let's get into it 💅

💖 NAME 💖

c8y-ui — the Cumulocity UI commands, periodt. that's the whole vibe.

🌸 SYNOPSIS 🌸

c8y ui [flags]

that's it. that's the whole entrance. flags go brrr 🎀

✨ DESCRIPTION ✨

UI Commands — literally just that. it's the UI command group, no cap. 🫶

👑 OPTIONS 👑

okay so these are the options that actually belong to this command:

  • -h, --help[=false] — shows help for ui. the classic. the icon. you already know 💅

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

lowkey this is the main character section — everything here is handed down from the parent command, and there are so many of them. buckle up, bestie 😭

  • --abortOnErrors=10 — aborts the whole batch once it hits the specified number of errors. like a vibe check that shuts the party down 🛑
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. empty is valid, okay?? 🙈
  • --cache[=false] — enable cached responses. save yourself the round trip ✨
  • --cacheBodyPaths=[] — limits the cache hashing to selected paths inside the json body. an empty value means all the values get hashed 🎀
  • --cacheTTL="60s" — cache time-to-live (TTL) written as a duration, i.e. 60s, 2m. yes, duration syntax, slay ⏳
  • -c, --compact[=false] — compact output instead of pretty-printed when you're using json output. ngl pretty print is the default if output is the terminal 🌸
  • --confirm[=false] — prompts you for confirmation. safety first, bestie 🫶
  • --confirmText="" — custom confirmation text. make it say whatever you want 💬
  • --currentPage=0 — the current page that should be returned 📄
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔗
  • --debug[=false] — set very verbose log messages. like, extremely. prepare to be humbled 💀
  • --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. look, don't touch ✋
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl 📝
  • --examples[=false] — show examples for the current command. tutorials era ✨
  • --filter=[] — applies a client side filter to the response before it gets returned to you. you get the good stuff only 🎀
  • --flatten[=false] — flattens json output by replacing nested json properties with properties whose names are written in dot notation. yes, flattening, we love a transformation 🦋
  • -f, --force[=false] — do not prompt for confirmation. this one is ignored when you're using --confirm — read that twice, bestie 👀
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
  • --includeAll[=false] — include all results by iterating through each page. all of them. every last one 🔁
  • -k, --insecure[=false] — allow insecure server connections when using SSL 🚨
  • -l, --logMessage="" — adds a custom message to the activity log 🗒️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited — and it literally says use with caution! so like… caution, bestie ⚠️
  • --noAccept[=false] — ignore the Accept header; this 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). cache said no 💅
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome moment 🖤
  • --noLog[=false] — disables the activity log for the current command 🚫
  • --noProgress[=false] — disable progress bars. no lil spinners for us 🙅
  • --noProxy[=false] — ignore the proxy settings 🚪
  • -n, --nullInput[=false] — don't read the input (stdin). useful if you're using it 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. five. iconic default 🎀
  • --progress[=false] — show the progress bar. heads up: 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 — it doesn't ask, it just does 🫡
  • --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 the session password 🤫
  • -U, --sessionUsername="" — override the 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 chatty era 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable it 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 👷

🌈 SEE ALSO 🌈

go read these next, bestie, they're all linked and they all ate:

ngl that's the whole page — every flag, every default, every weird little [=false] accounted for 💖

and that's a wrap, bestie!! this gorgeous little number is from the c8y(1) manual, dated Jan 1980 (yes really, that's the date on the tin 🕰️) — go forth and c8y ui responsibly 🫶✨🎀

📦 where this page comes from