c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’… c8y(1) β€” currentapplication, bestie edition πŸ’…

okay bestie, you’re chilling inside the c8y(1) manual and this page is all about currentapplication β€” it’s giving β€œsmall command, lots of inherited flags,” and honestly? We’re gonna get through every single one together 🫢

🌸 NAME 🌸

c8y-currentapplication β€” Cumulocity currentApplication πŸ’–

πŸ¦‹ SYNOPSIS πŸ¦‹

the whole shape of it:

c8y currentapplication [flags]

✨ DESCRIPTION ✨

okay so this is the REST endpoint to interact with Cumulocity currentApplication β€” that’s literally the description, and she ate πŸ’…

πŸ’– OPTIONS πŸ’–

  • -h, --help[=false] β€” shows help for currentapplication 🫢

🫢 OPTIONS INHERITED FROM PARENT COMMANDS 🫢

these are inherited from the parent command, but they still matter, so here’s every single one, no skipping:

  • --abortOnErrors=10 β€” aborts the batch when it reaches the specified number of errors πŸ’€
  • --allowEmptyPipe[=false] β€” doesn’t fail when piped input is empty (stdin) 🫢
  • --cache[=false] β€” enables cached responses ✨
  • --cacheBodyPaths=[] β€” limits cached 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 output is the terminal
  • --confirm[=false] β€” prompts for confirmation
  • --confirmText="" β€” custom confirmation text
  • --currentPage=0 β€” current page which should be returned
  • --customQueryParam=[] β€” adds custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] β€” sets 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; doesn’t send any data to the server
  • --dryFormat="markdown" β€” dry run output format, i.e. json, dump, markdown or curl
  • --examples[=false] β€” shows examples for the current command
  • --filter=[] β€” applies a client-side filter to the response before returning it to the user
  • --flatten[=false] β€” flattens 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] β€” includes all results by iterating through each page
  • -k, --insecure[=false] β€” allows insecure server connections when using SSL
  • -l, --logMessage="" β€” adds a custom message to the activity log
  • --maxJobs=0 β€” maximum number of jobs; 0 = unlimited (use with caution!) πŸ’€
  • --noAccept[=false] β€” ignore Accept header: removes the Accept header from requests, however PUT and POST requests will only see the effect
  • --noCache[=false] β€” forces cached responses off (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] β€” disables progress bars
  • --noProxy[=false] β€” ignores proxy settings
  • -n, --nullInput[=false] β€” doesn’t read input (stdin); useful if using in shell for/while loops
  • -o, --output="table" β€” output format, i.e. table, json, csv, csvheader
  • --outputFile="" β€” saves JSON output to file (after select/view)
  • --outputFileRaw="" β€” saves raw response to file (before select/view)
  • --outputTemplate="" β€” jsonnet template to apply to the output
  • -p, --pageSize=5 β€” maximum results per page
  • --progress[=false] β€” shows progress bar; this will also disable any other verbose output
  • --proxy="" β€” proxy setting, i.e. http://10.0.0.1:8080
  • -r, --raw[=false] β€” shows 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="" β€” overrides the default session mode for a single command which would normally be disabled
  • -P, --sessionPassword="" β€” overrides session password
  • -U, --sessionUsername="" β€” overrides 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] β€” requests Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13)
  • -t, --withTotalPages[=false] β€” requests Cumulocity to include the total pages in the response statistics under .statistics.totalPages
  • --workers=1 β€” number of workers

πŸŽ€ SEE ALSO πŸŽ€


okay that’s the whole manual, bestie 🫢 β€” footer vibes: source/version c8y(1), dated Jan 1980 ✨

πŸ“¦ where this page comes from