c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the extensions page, but make it make sense

okay so bestie, you opened c8y(1) and landed on the extensions page. don't panic, i got you 🫶 this is literally the whole vibe, translated, with nothing dropped. periodt.

✨ NAME ✨

c8y-extensions — Manage c8y extensions 🌸

✨ SYNOPSIS ✨

c8y extensions [flags]

✨ DESCRIPTION ✨

okay so here's the tea ☕ — go-c8y-cli extensions are repositories that give you extra c8y commands. like little add-on packs for your fave CLI. obsessed. 💖

The rules, and yes there are rules bestie:

  • The extension repository's name must start with "c8y-" and it must contain an executable with the same name. no cap, both. 🎀
  • Every argument you pass into the c8y [extname] invocation gets forwarded straight to the c8y-[extname] executable of the extension. it's giving relay race. 🏃‍♀️
  • An extension cannot override any of the core c8y commands. main character energy stays with the core, sorry not sorry. 👑

Wanna browse? See the list of available extensions at https://github.com/topics/c8y-extension — go shop, iykyk 🛍️✨

🎀 OPTIONS 🎀

  • -h, --help[=false] — help for extensions. the classic "what does this even do" button 🙈

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

okay this is the big one, the motherlode, the whole inheritance situation. these come from the parent command, they're not new here, but they are iconic and you need to know every single one 🧚

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin)
  • --cache[=false] — Enable cached responses
  • --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
  • --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 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 custom message to the activity log
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) ⚠️
  • --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
  • -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 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
ngl bestie, that's a lot of flags, and i listed every last one. you're welcome 💅

🦋 SEE ALSO 🦋

go touch some grass, then come back and read these:

and that's the whole page, bestie, you ate that 🍓✨ mwah 💖 oh and btw — this lil slice of manual-page history is dated Jan 1980 and belongs to the c8y(1) manual, so go forth and slay your extensions. periodt. 👑🌈

📦 where this page comes from