c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y(1) 💅✨

okay bestie, welcome to the c8y(1) manual — yes, the manual name is c8y(1), and today's main character is the alias-list command. She's tiny, she's useful, and she's about to tell you every alias c8y knows about. 🫶

🌸 NAME 🌸

c8y-alias-list — List your aliases. That's literally it, and honestly? iconic. 💖

✨ SYNOPSIS ✨

c8y alias list [flags]

🦋 DESCRIPTION 🦋

okay so this command prints out all of the aliases that c8y is configured to use. Every single one. It's giving "open the group chat and read the nicknames" energy, and no cap, that's the whole vibe. 💅

💅 OPTIONS 💅

  • -h, --help[=false] — help for list. Use it when you need the assist, bestie. 🎀

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

These bad girls come from the parent command, and they're all invited to the party:

  • --abortOnErrors=10 — Abort the batch when it reaches the specified number of errors; the number here is 10. 👑
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). She's sensitive, okay? 🥺
  • --cache[=false] — Enable cached responses. ✨
  • --cacheBodyPaths=[] — The cache should limit hashing to 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. Are you sure, bestie? 👀
  • --confirmText="" — Custom confirmation text. Make it cute. 💖
  • --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 gonna tell you everything. 💀
  • --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. Just pretend, bestie. 🙈
  • --dryFormat="markdown" — Dry run output format, i.e. json, dump, markdown or curl. ✨
  • --examples[=false] — Show examples for the current command. Free tutorial energy. 🎓
  • --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. No questions, just vibes. 🔥
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue". 📬
  • --includeAll[=false] — Include all results by iterating through each page. All of them. 👑
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. Living dangerously, bestie. 💀
  • -l, --logMessage="" — Add custom message to the activity log. Leave a lil note. 📝
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). She said caution for a reason. ⚠️
  • --noAccept[=false] — Ignore Accept header: this removes 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 little loading guys. 🚫
  • --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. Pick your aesthetic. 💅
  • --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. Five at a time, cute. 🍓
  • --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. She'll try three times. 💪
  • --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. Quiet girl era. 🤫
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. ⏰
  • --totalPages=0 — Total number of pages to get. 📚
  • -v, --verbose[=false] — Verbose logging. She's chatty. 💬
  • --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. Plot twist. 😭
  • --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. One busy bestie by default. 🐝

🌈 SEE ALSO 🌈

💖 that's the manual, bestie — source/version c8y(1), date Jan 1980, and yes she ate. 🎀

📦 where this page comes from