c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the cumulocity CLI, bestie edition 🎀

Okay so real talk: this is the manual page for c8y(1), the cumulocity command-line tool — and specifically for the createHostedApplication glow-up. Grab a strawberry drink 🍓, we're going in.

✨ NAME ✨

c8y-applications-createHostedApplication — literally just create a hosted application, that's the whole vibe 🦋

🌸 SYNOPSIS 🌸

c8y applications createHostedApplication [flags]

💖 DESCRIPTION 💖

Create a brand-new hosted web application — or, if you already have one, update the binary of an existing hosted application. Both. It's giving versatility 👑

And here's the little secret: if the zip file or folder contains a cumulocity.json manifest file, then the key will be automatically read from it. No cap, it just knows. 🔥

⭐ OPTIONS ⭐

  • --availability="" — the access level for other tenants. Possible values are MARKET and PRIVATE (that's the default, bb). 🙈
  • --contextPath="" — the contextPath of the hosted application.
  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' ✨
  • --file="" — File or Folder of the web application. It should contain a index.html file in the root folder/ or zip file. Yes, that's a requirement, not a suggestion 💅
  • -h, --help[=false] — help for createHostedApplication. Iconic, honestly.
  • --key="" — Shared secret of application. Defaults to the value inside the cumulocity.json file (if present). 🗝️
  • --name="" — Name of application.
  • --resourcesUrl="/" — URL to application base directory hosted on an external server. Required when application type is HOSTED — read that again, bestie, it matters. 🌈
  • --skipActivation[=false] — Don't activate to the application after it has been created and uploaded. Chill mode. 😴
  • --skipUpload[=false] — Don't uploaded the web app binary. Only the application placeholder will be created. (Yes the manpage says "Don't uploaded", we're keeping it, character for character 🫶)
  • --template="" — Body template.
  • --templateVars=[] — Body template variables.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

These are the ones you get for free from the parent command — the whole family tree is eating 🍽️

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin).
  • --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. For when you need everything, and I mean 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. Practice mode, lowkey 🧚
  • --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. ⚠️ Yes it's literally called insecure, proceed with intention.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Not me warning you dramatically 🔥
  • --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 🦋

Okay bestie, the receipts — three of them, all verbatim, all iconic:

$ c8y applications createHostedApplication --file ./myapp.zip
Create new hosted application from a given zip file. The application will be called "myapp". If the application placeholder does not exist then it will be created
$ c8y applications createHostedApplication --file simple-helloworld/build --name custom_helloworld
Create/update hosted web application from a build folder and specify a custom application name
$ c8y applications createHostedApplication --file myapp.zip --skipActivation
Create/update hosted web application but don't activate it, so the current version (if any) will be untouched

🌈 SEE ALSO 🌈

c8y-applications(1) — go say hi to the rest of the applications family, they're lovely 🫶

Reminder from your girl: keep your --key secret actually secret, and don't go nowhere near -k, --insecure unless you genuinely know what you're doing. 💀

and that's the page, bestie ✨ written into the manual as Jan 1980 under the c8y(1) banner — vintage date, modern energy, periodt 💅🎀

📦 where this page comes from