c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’– NAME πŸ’–

okay bestie, welcome to the c8y(1) manual page β€” specifically the c8y-configuration corner of it. This one is all about Cumulocity configuration repository management. πŸ’…

✨ SYNOPSIS ✨

c8y configuration [flags]

πŸ¦‹ DESCRIPTION πŸ¦‹

This is the configuration-management zone: you can create, list, and delete configurations. That’s the whole vibe. ✨

πŸŽ€ OPTIONS πŸŽ€

  • -h, --help[=false] β€” show the help for configuration, aka the thing you’re looking at right now. iconic.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay so these are the parent-command options that come along for the ride, and there are a lot of them. no skipping, bestie β€” every single one is here. 🫢

  • --abortOnErrors=10 β€” abort the batch when it reaches the number of errors you set.
  • --allowEmptyPipe[=false] β€” don’t fail when piped input (stdin) is empty.
  • --cache[=false] β€” enable cached responses.
  • --cacheBodyPaths=[] β€” limit cache hashing to selected paths in the JSON body; empty means all values.
  • --cacheTTL="60s" β€” cache time-to-live (TTL) as a duration, like 60s or 2m.
  • -c, --compact[=false] β€” when using JSON output, compact it instead of pretty-printing. Pretty print is the default when output is the terminal.
  • --confirm[=false] β€” prompt for confirmation.
  • --confirmText="" β€” set custom confirmation text.
  • --currentPage=0 β€” the current page that should be returned.
  • --customQueryParam=[] β€” add custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
  • --debug[=false] β€” set very verbose log messages.
  • --delay="0ms" β€” delay after each request, like 5ms or 1.2s.
  • --delayBefore="0ms" β€” delay before each request, like 5ms or 1.2s.
  • --dry[=false] β€” dry run: don’t send any data to the server.
  • --dryFormat="markdown" β€” dry-run output format, like json, dump, markdown, or curl.
  • --examples[=false] β€” show examples for the current command.
  • --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 whose names use dot notation.
  • -f, --force[=false] β€” don’t prompt for confirmation; ignored when using --confirm.
  • -H, --header=[] β€” custom headers, like --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 a custom message to the activity log.
  • --maxJobs=0 β€” maximum number of jobs; 0 = unlimited (the original literally says use with caution!).
  • --noAccept[=false] β€” ignore the Accept header by removing it from requests, however PUT and POST requests will only see the effect.
  • --noCache[=false] β€” force cached responses off (overwrites the 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 input (stdin). Useful if you’re using it in shell for/while loops.
  • -o, --output="table" β€” output format, like table, json, csv, or 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.
  • --progress[=false] β€” show a progress bar; this will also disable any other verbose output.
  • --proxy="" β€” proxy setting, like http://10.0.0.1:8080.
  • -r, --raw[=false] β€” show the 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, like --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, like 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, like 60s or 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 πŸ”₯

go check out the rest of the squad, bestie:


that’s the whole c8y(1) page, straight from the c8y(1) source/version and dated Jan 1980 β€” bye bestie, slay responsibly πŸŽ€πŸ’–

πŸ“¦ where this page comes from