c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌈 bestie's guide to c8y(1) — c8y-sessions-decryptText

okay so this is the c8y(1) manual page for c8y-sessions-decryptText, and it's all about decrypting text. no cap, very Unix, very slay. 💅

✨ NAME ✨

c8y-sessions-decryptText - Decrypt text.

🎀 SYNOPSIS 🎀

c8y sessions decryptText [flags]

Bestie, that's the whole invocation. The [flags] are where the options live. 🦋

💖 DESCRIPTION 💖

Decrypt text based on the same encryption used to store sensitive data a cumulocity session. That's the entire description, bestie — no extra lore. 😭

✨ OPTIONS ✨

Here are the options for this command, bestie:

  • -h, --help[=false] — shows help for decryptText. 🫶
  • --passphrase="" — passphrase to use for encrypting the text. It's read from env C8Y_PASSPHRASE or prompted if missing. iykyk, keep that passphrase safe. 💖
  • --text="" — encrypted text. It's required, and it accepts pipeline. required bestie, don't forget. 💅

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

These are inherited from the parent commands, and yes, there are a lot of them. We're listing every one, because bestie deserves the full set. 🌸

  • --abortOnErrors=10 — abort a batch when reaching the specified number of errors. Here that's 10. batch says bye when errors pile up. 💀
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe, no drama. 🫶
  • --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. ignored with --confirm, periodt. 💀
  • -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. insecure bestie, be careful. 💀
  • -l, --logMessage="" — add custom message to the activity log. 🎀
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). caution, bestie! 🔥
  • --noAccept[=false] — ignore Accept header; this 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. 🫶

🔥 EXAMPLE 🔥

Example 1:

c8y sessions decryptText --text "{encrypted}asdfasdfasdfasdfasdf"

The note here says: Encrypt the text "Hello World". You will be prompted for the passphrase to encrypt the data. Yes, that's what it says, bestie — I'm not changing the example. 😭

Example 2:

c8y sessions encryptText --text "Hello World" --passphrase "so4methIng-7hat-Matters"

The note here says: Encrypt the text "Hello World", the text will be encrypted using the given passphrase (without being prompted). no prompt, just vibes. 💅

🌸 SEE ALSO 🌸

That's the whole c8y(1) page, bestie — sourced from the c8y(1) manual and dated Jan 1980. 💖✨🎀

📦 where this page comes from