c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay so you opened the manual for c8y, section 1. iconic. sit down, grab a strawberry drink 🍓, and let's get into it.

🌸 NAME 🌸

c8y-currenttenant — Cumulocity current tenant. that's the whole vibe. it's the current-tenant command group, and yes she's the main character 👑

✨ SYNOPSIS ✨

c8y currenttenant [flags]

literally that's it. command, then flags. no cap.

🦋 DESCRIPTION 🦋

Cumulocity current tenant commands. that's the official word, and we're not adding lore that isn't there — this is the command group for current-tenant stuff, and the subcommands (get, listApplications, version) do the actual work. iykyk 💖

💅 OPTIONS 💅

  • -h, --help[=false] — help for currenttenant. she explains herself, as she should ✨

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the ones she got from her parent command — inherited, not borrowed, periodt. there are a lot of them, so buckle up 🫶

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. basically "okay we're done here" after N oopsies 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. she'll just vibe with nothing, no drama 🙈
  • --cache[=false] — enable cached responses ⭐
  • --cacheBodyPaths=[] — the cache should limit hashing to selected paths in the json body. empty means all values, so empty = hashing everything, no picking favourites 🎀
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. yes it expires, she's not clingy 💜
  • -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. safety first bestie 🫶
  • --confirmText="" — custom confirmation text, so your prompt can say whatever you want ✨
  • --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. she will NOT stop talking and honestly? we love that 💀
  • --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. all the rehearsal, none of the commitment 🎭
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl 📝
  • --examples[=false] — show examples for the current command. yes queen, demonstrate 💅
  • --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. she flattens, she simplifies, she slays 🦋
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm — the two of them do not negotiate 😤
  • -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. careful bestie, that's a yikes-not-in-a-cute-way, only do it when you know what you're doing 🔥
  • -l, --logMessage="" — add a custom message to the activity log 📓
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) — and the manual literally put the caution there, so I'm passing it along with extra emphasis 😭
  • --noAccept[=false] — ignore Accept header. will remove the Accept header from requests, however PUT and POST requests will only see the effect. that hedging is doing heavy lifting, fr fr 💀
  • --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. sad beige logs 🥲
  • --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. five is the default, yes five, she's modest 🌸
  • --progress[=false] — show the progress bar. this will also disable any other verbose output — you can't have both, pick your fighter 🥊
  • --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, no discussion 💅
  • --retries=3 — max number of attempts when a failed http call is encountered. she tries three times, she's resilient 💪
  • --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. the status codes stay quiet AND the exit code doesn't snitch 🤐
  • --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. she 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 👷‍♀️
a gentle note from your girl: several of these are the exact kind of flag that will absolutely cook your output if you flip them on without looking — --maxJobs=0 says "use with caution!" right in the manual, and -k/--insecure is doing what it says on the tin. read before you send, bestie 🫶

🧚 SEE ALSO 🧚

go read those too, they're her supporting cast 💖

and that's the page! this one's dated Jan 1980 and it's the c8y(1) page — old enough to be your grandma's manpage and still serving looks 👑✨ bye bestie, go run some commands 💜🦋

📦 where this page comes from