c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — sessions clear, but make it make sense 💅

okay so bestie, welcome to the manual for c8y sessions clear. This is the c8y(1) page, and we are clearing a session. No cap, it’s a tiny command with a whole inheritance situation. Let’s get into it. 🫶

📛 NAME 📛

c8y-sessions-clear — clear the current session. That’s the whole assignment. 💖

✨ SYNOPSIS ✨

c8y sessions clear [flags]

💬 DESCRIPTION 💬

okay so this command clears the current session by returning all the environment variables which should be unset via a shell snippet. Like, it hands you the unset-vibes snippet and your shell does the rest. 🧚

🎛️ OPTIONS 🎛️

  • -h, --help[=false] — help for clear. Your little “what does this do” button. 💅
  • --shell="auto" — Shell type. Defaults to auto if not printing to terminal. So it picks auto unless it’s outputting to a terminal. ✨

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

these are inherited, bestie — still fully relevant, still 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). Empty pipe? We vibing. 🫶
  • --cache[=false] — enable cached responses. Cache vibes only when it’s on. ⚡
  • --cacheBodyPaths=[] — the 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. The default is "60s". ⏳
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. So terminal gets the pretty; compact is for when you want it squished. 🎀
  • --confirm[=false] — prompt for confirmation. Yes, it will ask. 🙈
  • --confirmText="" — custom confirmation text. Make it say your own thing. 💬
  • --currentPage=0 — current page which should be returned. Starts at 0. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Exact example, no edits. 🔥
  • --debug[=false] — set very verbose log messages. It’s giving “I want to see everything”. 🔍
  • --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. Zero data sent. 🚫
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. Default "markdown". 🎨
  • --examples[=false] — show examples for the current command. Yes, examples within examples. 🤯
  • --filter=[] — apply a client side filter to response before returning it to the user. Client-side glow-up. 💅
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Dots instead of nested chaos. 🪄
  • -f, --force[=false] — do not prompt for confirmation. Ignored when using --confirm. So --confirm wins, bestie. 👑
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". Exact example. 📨
  • --includeAll[=false] — include all results by iterating through each page. All the pages, all the results. 🌈
  • -k, --insecure[=false] — allow insecure server connections when using SSL. That’s the flag. 🔓
  • -l, --logMessage="" — add custom message to the activity log. Leave your little note. 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). The caution is real, bestie. 💀
  • --noAccept[=false] — ignore Accept header — it removes the Accept header from requests, however PUT and POST requests will only see the effect. That nuance is real. 🚫
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). Cache? Not today. 🙅
  • -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 problem. 🤐
  • --noProgress[=false] — disable progress bars. No little bars. 📉
  • --noProxy[=false] — ignore the proxy settings. Bye proxy. 👋
  • -n, --nullInput[=false] — don’t read the input (stdin). Useful if using in shell for/while loops. Loop-friendly. 🔁
  • -o, --output="table" — output format i.e. table, json, csv, csvheader. Default "table". 📊
  • --outputFile="" — save JSON output to file (after select/view). After, bestie. 💾
  • --outputFileRaw="" — save raw response to file (before select/view). Before, bestie. 💾
  • --outputTemplate="" — jsonnet template to apply to the output. Fancy template time. 🎨
  • -p, --pageSize=5 — maximum results per page. Default 5. 📚
  • --progress[=false] — show progress bar. This will also disable any other verbose output. Progress bar > extra chatter. 📶
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. Exact vibe. 🌐
  • -r, --raw[=false] — show raw response. This mode will force output=json and view=off. Raw is raw. 🥩
  • --retries=3 — max number of attempts when a failed http call is encountered. Default 3. 🔁
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Exact example. 🎯
  • --session="" — session configuration. 🗂️
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. One-command override. 🕹️
  • -P, --sessionPassword="" — override session password. 🤫
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant). Exact examples. 👤
  • --silentExit[=false] — silent status codes do not affect the exit code. Silent but not exit-code-affecting. 🤫
  • --silentStatusCodes="" — status codes which will not print out an error message. Shhh. 🤐
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. Default "600s". ⌛
  • --totalPages=0 — total number of pages to get. Default 0. 📄
  • -v, --verbose[=false] — verbose logging. Talk to me. 🗣️
  • --view="auto" — use views when displaying data on the terminal. Disable using --view off. Default "auto". 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr. stdout specifically. 📤
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Exact path, exact version. 📈
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Exact path. 📑
  • --workers=1 — number of workers. Default 1. 👷

🌟 EXAMPLE 🌟

💖 Example 1: Clear session in bash 💖

$ eval $(c8y sessions clear)

Clear the current session. That’s it, that’s the vibe. ✨

🐟 Example 2: Clear session in fish 🐟

$ c8y sessions clear | source

👀 SEE ALSO 👀

🎀 that’s the whole page, bestie! source/version vibes: c8y(1); date: Jan 1980. iconic. 💅✨
📦 where this page comes from