c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 c8y — the Cumulocity command line interface 💅

ok so real quick bestie, this page is c8y(1) — the manual for the c8y command. buckle up, it's a big one, but it's literally just your new fave CLI 🫶

✨ NAME ✨

c8y — Cumulocity command line interface. yes that's it. that's the name. iconic behavior honestly 👑

🦋 SYNOPSIS 🦋

c8y [flags]

💖 DESCRIPTION 💖

so c8y is a command line interface that lets you interact with the Cumulocity REST API ✨ and ngl it's the vibe. it's described as ideal for three things, and I'm quoting the source here because it's not my place to lie to you:

  • quick prototyping 🔥
  • exploring the REST API 🔍
  • Platform maintainers / power users 👑

so like. if you're any of those three things, this is your moment. main character energy fr.

💅 OPTIONS 💅

okay here's the big list. every single flag, every default, no skips, no cap. take a sip of water first 🍓

  • --abortOnErrors=10 — abort the batch once it hits the specified number of errors. like a "okay I'm done" button 🛑
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. empty pipe? no drama 💀
  • --cache[=false] — enable cached responses ✨
  • --cacheBodyPaths=[] — cache should limit hashing to 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 ⏳
  • -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 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 💪
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
  • -h, --help[=false] — help for c8y 🆘
  • --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 — and it literally says (use with caution!) so like… caution, bestie ⚠️
  • --noAccept[=false] — ignore the 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 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 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 👷
lowkey that's a LOT of flags but you ate that. go drink some water 💜

🎀 EXAMPLE 🎀

here's the part you actually came for, the receipts ✨

$ c8y devices list
$ c8y devices list --type "myDevice" | c8y devices update --data "myValue=1"
$ c8y operations list --device myDeviceName

the pipe in the middle one? that's the whole vibe. listing then updating in one line, we love a one-liner 👑

🌈 SEE ALSO 🌈

so many siblings, a whole family, iykyk 💖

c8y-activitylog(1), c8y-agents(1), c8y-alarms(1), c8y-alias(1), c8y-api(1), c8y-applications(1), c8y-assert(1), c8y-auditrecords(1), c8y-binaries(1), c8y-bulkoperations(1), c8y-cache(1), c8y-cli(1), c8y-completion(1), c8y-configuration(1), c8y-currentapplication(1), c8y-currenttenant(1), c8y-currentuser(1), c8y-databroker(1), c8y-datahub(1), c8y-devicegroups(1), c8y-devicemanagement(1), c8y-deviceprofiles(1), c8y-deviceregistration(1), c8y-devices(1), c8y-events(1), c8y-extensions(1), c8y-features(1), c8y-firmware(1), c8y-identity(1), c8y-inventory(1), c8y-measurements(1), c8y-microservices(1), c8y-notification2(1), c8y-operations(1), c8y-realtime(1), c8y-remoteaccess(1), c8y-retentionrules(1), c8y-scripts(1), c8y-sessions(1), c8y-settings(1), c8y-smartgroups(1), c8y-software(1), c8y-systemoptions(1), c8y-template(1), c8y-tenantoptions(1), c8y-tenants(1), c8y-tenantstatistics(1), c8y-ui(1), c8y-usergroups(1), c8y-userreferences(1), c8y-userroles(1), c8y-users(1), c8y-util(1), c8y-version(1)

and that's the whole page, bestie 🫶 no notes, slay 💅

kisses, this was c8y(1) — dated Jan 1980 (yes really, that date is doing its own thing and we respect it) 🌸✨🎀

📦 where this page comes from