c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the Cumulocity CLI, but make it make sense

okay so real talk, bestie: this whole page lives inside the c8y manual (that's the manual name, bestie, section 1, the big one) — and this page is the inventory corner of it. no cap, it's a lot of flags, but we're gonna get through it together. grab a lil snack 🍓

✨ NAME ✨

c8y-inventory — Cumulocity managed objects. that's it, that's the vibe. it's the inventory plugin, it does managed objects, it slays.

🦋 SYNOPSIS 🦋

c8y inventory [flags]

🌸 DESCRIPTION 🌸

REST endpoint to interact with Cumulocity managed objects. literally just — you point it at managed objects, it does managed object things. iconic behavior fr fr.

🎀 OPTIONS 🎀

  • -h, --help[=false] — help for inventory. the classic "what does this do again" button 🫶

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

okay this is the long part, but every single one of these lives on the parent command and trickles down to you, so you get them for free. no skipping, stay with me 💖

  • --abortOnErrors=10 — abort batch when reaching specified number of errors. like, if enough things break, bestie, we stop.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe = not a crisis.
  • --cache[=false] — enable cached responses. speed, queen.
  • --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. (pretty print is the main character here, ngl)
  • --confirm[=false] — prompt for confirmation.
  • --confirmText="" — custom confirmation text. you can make it say whatever ✨
  • --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. the "tell me EVERYTHING" mode 💀
  • --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. practice mode, no consequences 🧚
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] — show examples for the current command. when you're like "wait show me".
  • --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. get the whole collection, not just page one 👑
  • -k, --insecure[=false] — allow insecure server connections when using SSL. > yes it's literally called insecure, and yes, it means what it says — be careful with it.
  • -l, --logMessage="" — add custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). that caution is theirs, not mine, and they meant it 🔥
  • --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. lowkey a lifesaver in loops fr.
  • -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. it overrides your choices, that's just how it is 💅
  • --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.

🌈 SEE ALSO 🌈

the friend group 🫶 go check them out:

💀 and yes, the footer really does say Jan 1980 — c8y(1), version-dated like it's been here since before we were born. truly vintage. she's been iconic since day one, periodt 🎀✨🦋
📦 where this page comes from