c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🎀 c8y(1) — bestie edition 🎀

okay so we're diving into the c8y manual, specifically the c8y sessions encryptText part of it. it's giving "small command, big energy" and honestly? obsessed. everything in the c8y(1) page is here, nothing skipped, pinky promise 🫶

✨ NAME ✨

c8y-sessions-encryptText — literally just Encrypt text. that's the whole job. she's focused, she's iconic 💅

🌸 SYNOPSIS 🌸

c8y sessions encryptText [flags]

🦋 DESCRIPTION 🦋

so what does this actually do? it encrypts text using the same encryption that's used for securely storing sensitive Cumulocity session information. no cap, same crypto energy, so your secrets stay secrets 🔒✨

💖 OPTIONS 💖

the ones that belong to this command specifically:

  • -h, --help[=false] — help for encryptText. classic, love her.
  • --passphrase="" — the passphrase you wanna use for encrypting the text. it gets read from the env var C8Y_PASSPHRASE, or you get prompted if it's missing. never not being asked, smh 😭
  • --text="" — the text to be encrypted. (required) and it accepts pipeline, so pipe away bestie 🧚

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these come from the parent command and honestly they ate. full list, no skips:

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). be nice to empty pipes fr fr.
  • --cache[=false] — enable cached responses.
  • --cacheBodyPaths=[] — cache should limit hashing of 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] — 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. she's loud 📢
  • --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. (hi, that's this vibe ✨)
  • --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. ⚠️ insecure is literally in the name, be careful.
  • -l, --logMessage="" — add custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). she said caution, so like, 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.

🌈 EXAMPLE 🌈

Example 1: Encrypt the text "Hello World". You will be prompted for the passphrase to encrypt the data.

> c8y sessions encryptText --text "Hello World"
Enter passphrase 🔒: [input is hidden]
{encrypted}ec5b837a03408ffb731307584eac40ac047989a002951e4b7139fa60189e504b6840bc027cece28b3f36717839d96af1c5dba8c850b9a9079846066ee1596cc8d26f4138f76ce3

Example 2: Encrypt the text "Hello World", the text will be encrypted using the given passphrase (without being prompted).

> c8y sessions encryptText --text "Hello World" --passphrase "so4methIng-7hat-Matters"
{encrypted}ec5b837a03408ffb731307584eac40ac047989a002951e4b7139fa60189e504b6840bc027cece28b3f36717839d96af1c5dba8c850b9a9079846066ee1596cc8d26f4138f76ce3
ngl that {encrypted} prefix is cute and also the whole point — that's your ciphertext, bestie 🔐

🍓 SEE ALSO 🍓

  • c8y-sessions(1) — go read the parent, she's the main character energy behind all of this 💜

that's the whole page, fr fr. this was the c8y(1) manual from Jan 1980, version/date baked right in — slay, we stan a timeless icon 🎀✨💖

📦 where this page comes from