c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) 💖

Okay so this is the manual page for c8y-agents, aka Cumulocity agents. The manual name is c8y(1), and this specific page is serving agent realness. Welcome to the group chat, bestie. 🫶

✨ NAME ✨

c8y-agents — Cumulocity agents. That's the name, that's the vibe, no notes. 💅

🦋 SYNOPSIS 🦋

c8y agents [flags]

💅 DESCRIPTION 💅

It's the REST endpoint to interact with Cumulocity agents. Literally that's the whole quest. 🎀

👑 OPTIONS 👑

  • -h, --help[=false] — help for agents. Iconic little helper behavior. ✨

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These are the parent-command flags that come along for the ride, bestie. Every single one is here, defaults and all. 🦋

  • --abortOnErrors=10 — abort the batch when it reaches the specified number of errors. Lowkey a safety rail. 🛑
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). Empty pipe? No drama. 🫧
  • --cache[=false] — enable cached responses. Cache era. ✨
  • --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. Time is fake but TTL is real. ⏳
  • -c, --compact[=false] — compact instead of pretty-printed output when using JSON output. Pretty print is the default if output is the terminal. Compact mode is giving minimalism. 💅
  • --confirm[=false] — prompt for confirmation. Consent check, but for commands. 🙈
  • --confirmText="" — custom confirmation text. Make it say what you want, within reason. 💬
  • --currentPage=0 — current page which should be returned. Page zero, bestie. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Query-param customization is a whole art form. 🎨
  • --debug[=false] — set very verbose log messages. Turn the volume all the way up. 🔍
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. A lil pause between moves. ⏱️
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Pause first, then slay. 💫
  • --dry[=false] — dry run. Don't send any data to the server. Practice mode, no consequences. 🧪
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. Choose your dry-run outfit. 👗
  • --examples[=false] — show examples for the current command. Examples ate, fr fr. 📚
  • --filter=[] — apply a client side filter to response before returning it to the user. Filter it before it hits your feed. 🧼
  • --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. No prompt, no pause. ⚡
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". Header game strong. 💌
  • --includeAll[=false] — include all results by iterating through each page. Collect the whole set, no crumbs left behind. 🧺
  • -k, --insecure[=false] — allow insecure server connections when using SSL. Dangerous-ish energy, so know what you're doing. 🚨
  • -l, --logMessage="" — add a custom message to the activity log. Leave a lil note in the group chat. 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). Unlimited is iconic until it's not. 😭
  • --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). Cache? Never heard of her. 🙅
  • -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. No log, no trace, just vibes. 🫧
  • --noProgress[=false] — disable progress bars. No lil loading bar situations. 🚫
  • --noProxy[=false] — ignore the proxy settings. Proxy who? 🙈
  • -n, --nullInput[=false] — don't read the input (stdin). Useful if using in shell for/while loops. Bestie said no stdin today. ✋
  • -o, --output="table" — output format i.e. table, json, csv, csvheader. Pick your output aesthetic. 📊
  • --outputFile="" — save JSON output to file (after select/view). Save it for later. 💾
  • --outputFileRaw="" — save raw response to file (before select/view). Raw and unfiltered, as the universe intended. 🌌
  • --outputTemplate="" — jsonnet template to apply to the output. Template era. 🎀
  • -p, --pageSize=5 — maximum results per page. Five per page, cute and contained. 📄
  • --progress[=false] — show progress bar. This will also disable any other verbose output. Progress bar is the main character now. 👑
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. Proxy config, very demure. 🔌
  • -r, --raw[=false] — show raw response. This mode will force output=json and view=off. Raw mode said no filters, no views, just data. 💀
  • --retries=3 — max number of attempts when a failed HTTP call is encountered. Try again, bestie. 🔁
  • --select=[] — comma separated list of properties to return. Wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Selective and slay. 🎯
  • --session="" — session configuration. Session setup has entered the chat. 🪑
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. One-command override moment. 🔄
  • -P, --sessionPassword="" — override session password. Password override, handle with care. 🔐
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant). Username glow-up. 🪪
  • --silentExit[=false] — silent status codes do not affect the exit code. Silent but not chaotic. 🤫
  • --silentStatusCodes="" — status codes which will not print out an error message. Some status codes just don't need to be loud. 🔇
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. Wait time, but make it boundaries. ⌛
  • --totalPages=0 — total number of pages to get. Page count goals. 📚
  • -v, --verbose[=false] — verbose logging. Tell me everything, honestly. 🗣️
  • --view="auto" — use views when displaying data on the terminal. Disable using --view off. View mode is auto by default. 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr. Error relocation realness. 🚚
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Stats girlies rise. 📈
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. More stats, more power. 🔢
  • --workers=1 — number of workers. One worker default, but the potential is there. 🛠️

🌸 SEE ALSO 🌸

And that's the page, bestie. Its little sign-off says c8y(1) with the date Jan 1980 — vintage timestamp behavior, honestly iconic. 🎀💖✨

📦 where this page comes from