c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’– NAME πŸ’–

okay bestie, welcome to the c8y(1) manual page for c8y-applications-open β€” literally β€œOpen application in a web browser.” that's the whole assignment. you point it at an app, and it opens in the browser. iconic. πŸŽ€

✨ SYNOPSIS ✨

c8y applications open [flags]

that's the shape of it: command, subcommand, [flags]. slay.

🌸 DESCRIPTION 🌸

Open application in a web browser. no cap, that's the vibe. πŸ¦‹

πŸ’… OPTIONS πŸ’…

  • --application="devicemanagement" β€” application name. this is the app you're opening, and the flag string already shows devicemanagement.
  • --device=[] β€” device to be opened up to. only valid if the template references {device}. (accepts pipeline, iykyk)
  • -h, --help[=false] β€” help for open. yes bestie, it's the help flag for this exact subcommand.
  • --noBrowser[=false] β€” print destination URL instead of opening the browser. no pop-up, just the URL.
  • --page="" β€” device management page to open. only valid for a specific device.
  • --path="" β€” custom path template which can reference values such as: {application}, {device}, {page}. path template supremacy.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

  • --abortOnErrors=10 β€” abort batch when reaching specified number of errors. the batch says bye when it hits that many errors.
  • --allowEmptyPipe[=false] β€” don't fail when piped input is empty (stdin). empty pipe? no drama, don't fail.
  • --cache[=false] β€” enable cached responses. turn on cached responses.
  • --cacheBodyPaths=[] β€” cache should limit hashing of selected paths in the json body. empty indicates all values. so empty = all values.
  • --cacheTTL="60s" β€” cache time-to-live (TTL) as a duration, i.e. 60s, 2m. duration vibes.
  • -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 = pretty by default, this makes it compact.
  • --confirm[=false] β€” prompt for confirmation. asks first, bestie.
  • --confirmText="" β€” custom confirmation text. your own confirmation message.
  • --currentPage=0 β€” current page which should be returned. which page is current / should be returned.
  • --customQueryParam=[] β€” add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. custom query params go brr.
  • --debug[=false] β€” set very verbose log messages. very verbose logs.
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s. wait after each request.
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s. wait before each request.
  • --dry[=false] β€” dry run. don't send any data to the server. no data goes to the server.
  • --dryFormat="markdown" β€” dry run output format. i.e. json, dump, markdown or curl. format options, take your pick.
  • --examples[=false] β€” show examples for the current command. show examples, love that.
  • --filter=[] β€” apply a client side filter to response before returning it to the user. client-side filter before it comes back to you.
  • --flatten[=false] β€” flatten json output by replacing nested json properties with properties where their names are represented by dot notation. flatten nested json into dot-notation names.
  • -f, --force[=false] β€” do not prompt for confirmation. ignored when using --confirm. no prompt, but --confirm wins.
  • -H, --header=[] β€” custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". custom headers, bestie.
  • --includeAll[=false] β€” include all results by iterating through each page. all results, page by page.
  • -k, --insecure[=false] β€” allow insecure server connections when using SSL. yes, that's the insecure one.
  • -l, --logMessage="" β€” add custom message to the activity log. custom activity log message.
  • --maxJobs=0 β€” maximum number of jobs. 0 = unlimited (use with caution!). 0 means unlimited, and yes: 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. removes the Accept header; PUT and POST requests will only see the effect.
  • --noCache[=false] β€” force disabling of cached responses (overwrites cache setting). force off caching, overwrites cache setting.
  • -M, --noColor[=false] β€” don't use colors when displaying log entries on the console. no color in console log entries.
  • --noLog[=false] β€” disables the activity log for the current command. turns off activity log for this command.
  • --noProgress[=false] β€” disable progress bars. no progress bars.
  • --noProxy[=false] β€” ignore the proxy settings. ignore proxy settings.
  • -n, --nullInput[=false] β€” don't read the input (stdin). useful if using in shell for/while loops. don't read stdin; useful in shell for/while loops.
  • -o, --output="table" β€” output format i.e. table, json, csv, csvheader. output format, periodt.
  • --outputFile="" β€” save JSON output to file (after select/view). save JSON output after select/view.
  • --outputFileRaw="" β€” save raw response to file (before select/view). save raw response before select/view.
  • --outputTemplate="" β€” jsonnet template to apply to the output. jsonnet template for the output.
  • -p, --pageSize=5 β€” maximum results per page. max results per page.
  • --progress[=false] β€” show progress bar. this will also disable any other verbose output. show progress bar; also disables any other verbose output.
  • --proxy="" β€” proxy setting, i.e. http://10.0.0.1:8080. proxy setting, e.g. that URL.
  • -r, --raw[=false] β€” show raw response. this mode will force output=json and view=off. raw response mode; forces output=json and view=off.
  • --retries=3 β€” max number of attempts when a failed http call is encountered. max attempts when an http call fails.
  • --select=[] β€” comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. comma-separated properties; wildcards and globstar accepted.
  • --session="" β€” session configuration. session config.
  • --sessionMode="" β€” override default session mode for a single command which would normally be disabled. override default session mode for one command that would normally be disabled.
  • -P, --sessionPassword="" β€” override session password. override session password.
  • -U, --sessionUsername="" β€” override session username. i.e. peter or t1234/peter (with tenant). override session username, like peter or t1234/peter with tenant.
  • --silentExit[=false] β€” silent status codes do not affect the exit code. silent status codes don't affect exit code.
  • --silentStatusCodes="" β€” status codes which will not print out an error message. status codes that won't print an error message.
  • --timeout="600s" β€” request timeout duration, i.e. 60s, 2m. timeout duration, like 60s or 2m.
  • --totalPages=0 β€” total number of pages to get. total pages to get.
  • -v, --verbose[=false] β€” verbose logging. verbose logging.
  • --view="auto" β€” use views when displaying data on the terminal. disable using --view off. use views on terminal; disable with --view off.
  • --withError[=false] β€” errors will be printed on stdout instead of stderr. errors go to stdout instead of stderr.
  • --withTotalElements[=false] β€” request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). ask Cumulocity to include total elements under .statistics.totalElements; introduced in 10.13.
  • -t, --withTotalPages[=false] β€” request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. ask Cumulocity for total pages under .statistics.totalPages.
  • --workers=1 β€” number of workers. number of workers.

πŸ”₯ EXAMPLE πŸ”₯

$ c8y applications open --application cockpit

opens the cockpit application in a local web browser. obsessed. πŸ’–

$ c8y devices list | c8y applications open --application devicemanagement --page control

opens multiple web browser tabs in the devicemanagement application, one for each device found. yes bestie, multiple tabs, one per device. 🫢

$ c8y devicegroups list | c8y applications open --path "/apps/cockpit/index.html#/group/{device}/subassets"

opens multiple web browser tabs for a list of device groups in the cockpit application. the way that path template ate. πŸŽ€

πŸ¦‹ SEE ALSO πŸ¦‹


cute sign-off: this is the c8y(1) manual page from Jan 1980, and that's the whole vibe. πŸ’œ

πŸ“¦ where this page comes from