c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y(1) — util show 🎀

Okay bestie, this is the manual page for c8y-util-show, aka the util show command. c8y(1) is the manual name, and we're about to get into it. ✨

NAME 💖

c8y-util-show — show json input. That's the name and the whole vibe. 🫶

SYNOPSIS ✨

c8y util show [flags]

DESCRIPTION 🌸

Generic utility to process json lines — literally one json object per line — using the same logic that the other c8y commands use. It's giving "little helper with main character energy." 💅

OPTIONS 🌈

-h, --help[=false] — help for show. Lowkey iconic for when you're lost.
--input="" — the input value to be repeated. It's required, and it accepts pipeline input. Don't forget it, bestie. 🫶

OPTIONS INHERITED FROM PARENT COMMANDS 🫶

Okay so these are inherited from the parent commands, and there are a lot of them. But we're listing every single one, no cap. 👑

--abortOnErrors=10 — abort the batch when it hits the specified number of errors.
--allowEmptyPipe[=false] — don't fail when the piped input is empty (stdin). Very "grace, but for pipes." 🎀
--cache[=false] — enable cached responses.
--cacheBodyPaths=[] — cache should limit hashing to the selected paths in the json body. Empty indicates all values.
--cacheTTL="60s" — cache time-to-live (TTL), written 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 the output is the terminal. It's giving neat-freak energy. ✨
--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. The logs are gonna spill the tea. 🍵
--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 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.
-f, --force[=false] — do not prompt for confirmation. Ignored when using --confirm. Not me ignoring the confirm option. 🙈
-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. Use with care, bestie — the vibes are insecure for a reason. 🔥
-l, --logMessage="" — add a custom message to the activity log.
--maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) This is highkey a "hold my iced coffee" option. 💀
--noAccept[=false] — ignore Accept header, which 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. Monochrome moment. 🖤
--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. It's giving "no filter, raw and real." 💅
--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.

EXAMPLE 🦋

Okay, examples are the best part. Look at this little pipeline moment:

$ echo myfile.json | c8y util show --select id,name

Process input json lines files and select id and name fields. Slay. ✨

And then this two-step situation:

$ c8y devices list > devices.json
$ c8y util show --input devices.json --select id,name --output csv

Save a devices list to file, then process the file in a second step and convert it to csv while only keeping id and name columns (with no headers). It's giving "organized queen." 👑