c8y(1)

💖 NAME 💖

okay so bestie, this is the c8y(1) manual page — the NAME line is literally c8y-completion, and its whole iconic job is Generate completion script. that's it, that's the main character energy ✨

🦋 SYNOPSIS 🦋

c8y completion [bash|zsh|fish|powershell]

🌸 DESCRIPTION 🌸

to load completions, use the shell of your choosing. pick your fave from bash, zsh, fish, or powershell, and let the completion script do its thing 💅

🐚 Bash

source it for the current session:

$ source <(c8y completion bash)

# To load completions for each session, execute once:

# Linux
$ c8y completion bash > /etc/bash_completion.d/c8y

# macOS
$ c8y completion bash > $(brew --prefix)/etc/bash_completion.d/c8y

🧚 Zsh

$ autoload -U compinit; compinit;
$ source <(c8y completion zsh)

# If shell completion is not already enabled in your environment,
# you will need to enable it.  You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

# To load completions for each session, execute once:
$ c8y completion zsh > "${fpath[1]}/_c8y"

# You will need to start a new shell for this setup to take effect.

🍓 fish

$ set -x LANG C.UTF-8
$ c8y completion fish | source

# To load completions for each session, execute once:
$ c8y completion fish > ~/.config/fish/completions/c8y.fish

💜 PowerShell

PS> c8y completion powershell | Out-String | Invoke-Expression

# To load completions for every new session, run:
PS> c8y completion powershell > c8y.ps1
# and source this file from your PowerShell profile.

---

✨ OPTIONS ✨

• -h, --help[=false] — help for completion, bestie 🫶

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

• --abortOnErrors=10 — abort batch when reaching the specified number of errors; default is 10.
• --allowEmptyPipe[=false] — don't fail when piped input (stdin) is empty.
• --cache[=false] — enable cached responses.
• --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; 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.
• --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 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".
• --includeAll[=false] — include all results by iterating through each page.
• -k, --insecure[=false] — allow insecure server connections when using SSL.
• -l, --logMessage="" — add custom message to the activity log.
• --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.
• --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.

🌈 SEE ALSO 🌈

c8y(1) — go peek at the parent page, bestie 💖

---

mwah 💋 that's the whole iconic page — it's from Jan 1980, and it's the c8y(1) manual. periodt ✨🫶