c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y(1) — alias set, but make it cute 💅

🌸 NAME

c8y-alias-set — create a shortcut for a c8y command. Basically giving a word main character energy so it expands into a whole c8y situation. ✨

🦋 SYNOPSIS

c8y alias set   [flags]

🎀 DESCRIPTION

Okay so bestie, this is where you declare a word as a command alias that will expand to the specified command(s). The expansion may specify additional arguments and flags. If the expansion includes positional placeholders such as $1, $2, etc., any extra arguments that follow the invocation of an alias will be inserted appropriately. If --shell is specified, the alias will be run through a shell interpreter (sh). This allows you to compose commands with | or redirect with >.

Not me warning you: extra arguments following the alias will not be automatically passed to the expanded expression. To have a shell alias receive arguments, you must explicitly accept them using $1, $2, etc., or $@ to accept all of them. 💀

Platform note, iykyk: on Windows, shell aliases are executed via sh as installed by Git For Windows. If you have installed git on Windows in some other way, shell aliases may not work for you. Quotes must always be used when defining a command as in the examples. 💅

💖 OPTIONS

  • -h, --help[=false] — help for set. Cute little assist era.
  • -s, --shell[=false] — declare an alias to be passed through a shell interpreter. Shell-girl summer.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS

  • --abortOnErrors=10 — abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). Empty pipe? Still slaying.
  • --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.
  • -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.

⭐ EXAMPLE

$ c8y alias set createTestDevice 'devices create --template test.device.json'
$ c8y createTestDevice
#=> c8y devices create --template test.device.json

$ c8y alias set listAlarmsByType 'alarms list --type="$1"'
$ c8y listAlarmsByType myType
#=> c8y alarms list --type="myType"

$ c8y alias set recentEvents 'operations list --dateFrom="-1h"'
$ c8y recentEvents
#=> c8y operations list --dateFrom="-1h"

$ c8y alias set --shell findInAudit 'c8y auditrecords list --dateFrom="-30d" --view auto --includeAll | grep $1'
$ c8y findInAudit deleted
#=> c8y auditrecords list --dateFrom="-30d" --output json --view auto --includeAll | grep deleted

👑 SEE ALSO

c8y-alias(1) — go read it next, bestie 🫶

xoxo from the c8y(1) girlies 💖 — Jan 1980 edition, c8y(1) manual energy 🌸

📦 where this page comes from