c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y girlies' field guide 🎀

okay so bestie, this is c8y(1), like the whole command line tool — and this page right here? it's all about the assert text glow-up ✨ c8y-assert-text is the name on the birth certificate, and its whole job is literally just Assert text. that's it, that's the vibe. 💖

✨ NAME ✨

c8y-assert-text — assert text, bestie. no cap, that's what it does. 🦋

🌸 SYNOPSIS 🌸

c8y assert text [flags]

💜 DESCRIPTION 💜

it asserts text input. like, you give it text, it checks the text, and it tells you if your text is giving what it's supposed to give. simple. iconic. periodt. 🔥

🎀 OPTIONS 🎀

  • --exact="" — match the text exactly, character for character. it's case sensitive, so don't come at it with your lowercase when it asked for uppercase, ok? 💅
  • -h, --help[=false] — help for text. your little emotional support flag when you're lost. 🫶
  • --input="" — the input value to be repeated. this one is required (!!), and yes it accepts pipeline, so you can pipe stuff straight in. 🍓
  • --regex="" — match against a regular expression. also case sensitive, regex girlies stay winning. ⭐
  • --schema="" — match against a json schema. for the structured-data girlies who need ✨validation✨.
  • --strict[=false] — strict mode. fail if no match is found. it's giving "no match? we're not doing that here." 💀

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the family flags — inherited, but still main character energy fr fr.

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. default is 10, so you get ten strikes before it's over. 😭
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. like, let the girl breathe. 🧚
  • --cache[=false] — enable cached responses. speed. ⚡
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. an empty value indicates all values. 💖
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default 60s. 🌸
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. lowkey important: pretty print is the default if output is the terminal. ✨
  • --confirm[=false] — prompt for confirmation. consent is key, bestie. 🫶
  • --confirmText="" — custom confirmation text. make it say whatever you want. 🎀
  • --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. strap in, she's gonna talk. 💀
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default 0ms. ⏳
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default 0ms. ⏳
  • --dry[=false] — dry run. don't send any data to the server. dress rehearsal only, no actual performance. 💅
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl. default markdown. 📝
  • --examples[=false] — show examples for the current command. yes bestie, there are examples, scroll down babe. 👀
  • --filter=[] — apply a client side filter to the response before returning it to the user. sift that tea. 🍵
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore. 🦋
  • -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. all of it. every crumb. 🍪
  • -k, --insecure[=false] — allow insecure server connections when using SSL. ⚠️ yes she said it, she's being insecure on purpose, use with care bestie.
  • -l, --logMessage="" — add custom message to the activity log. leave a lil note for the group chat. 💌
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with 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. monochrome moment. 🖤
  • --noLog[=false] — disables the activity log for the current command. 🤫
  • --noProgress[=false] — disable progress bars. no lil bars, just vibes. 🚫
  • --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. default table. 📊
  • --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. fancy. ✨
  • -p, --pageSize=5 — maximum results per page. default 5. 📖
  • --progress[=false] — show progress bar. heads up though: 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. no filter, no fuss. 🪞
  • --retries=3 — max number of attempts when a failed http call is encountered. default 3. she tries, ok? she tries. 😤
  • --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. default 600s. ⏰
  • --totalPages=0 — total number of pages to get. 📚
  • -v, --verbose[=false] — verbose logging. she's telling you everything. 🗣️
  • --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. default 1. 👯

🌈 EXAMPLE 🌈

assert that the input matches a given schema 🧚

$ echo "{\"name\": \"device01\"}" | c8y assert text --schema "myschema.json"

assert that the input text matches a given string exactly (case sensitive) 💅

$ echo "myname" | c8y assert text --exact "myname"

assert that the input text matches a given regular expression (case sensitive) 🔥

$ echo "myname" | c8y assert text --regex '.*name$'

🦋 SEE ALSO 🦋

💖 reminder bestie: --exact and --regex are case sensitive, --force gets ignored when you use --confirm, and --maxJobs=0 means unlimited — use with caution, ok?? i'm not gonna say it twice. 😭

k bye ily, this page is from Jan 1980 and it says c8y(1) at the bottom so you know it's the real one — see you in the next manpage, mwah 🎀💜🫶

📦 where this page comes from