Apps commands

Reference for the `revenexx apps` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

apps generate and apps capabilities come from the create plugin — see Scaffolding for the app codegen commands.

Every revenexx apps subcommand. The example shows the required arguments; the options table lists every flag the command accepts, with a ✓ marking required flags. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx apps <command> --help for the live options.

create

Bash

revenexx apps create \
    --function-id sample-id \
    --name Sample name \
    --runtime node-18.0

Flag	Required	Description
`--function-id <function-id>`		Function ID. Choose a custom ID or generate a random ID with \
`--name <name>`		Function name. Max length: 128 chars.
`--runtime <runtime>`		Execution runtime.
`--commands <commands>`		Build Commands.
`--enabled [value]`		Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
`--entrypoint <entrypoint>`		Entrypoint File. This path is relative to the "providerRootDirectory".
`--events [events...]`		Events list. Maximum of 100 events are allowed.
`--execute [execute...]`		—
`--installation-id <installation-id>`		—
`--logging [value]`		When disabled, executions will exclude logs and errors, and will be slightly faster.
`--provider-branch <provider-branch>`		Production branch for the repo linked to the function.
`--provider-repository-id <provider-repository-id>`		Repository ID of the repo linked to the function.
`--provider-root-directory <provider-root-directory>`		Path to function code in the linked repo.
`--provider-silent-mode [value]`		Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
`--schedule <schedule>`		Schedule CRON syntax.
`--scopes [scopes...]`		List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
`--specification <specification>`		Runtime specification for the function and builds.
`--timeout <timeout>`		Function maximum execution time in seconds.

create-deployment

Bash

revenexx apps create-deployment \
    --function-id sample-id \
    --activate true \
    --code 'path/to/file.png'

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--activate <activate>`		Automatically activate the deployment when it is finished building.
`--code <code>`		—
`--commands <commands>`		Build Commands.
`--entrypoint <entrypoint>`		Entrypoint File.

create-duplicate-deployment

Bash

revenexx apps create-duplicate-deployment \
    --function-id sample-id \
    --deployment-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--deployment-id <deployment-id>`		Deployment ID.
`--build-id <build-id>`		Build unique ID.

create-execution

Bash

revenexx apps create-execution \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--async [value]`		Execute code in the background. Default value is false.
`--body <body>`		HTTP body of execution. Default value is empty string.
`--headers <headers>`		HTTP headers of execution. Defaults to empty.
`--method <method>`		HTTP method of execution. Default value is POST.
`--path <path>`		HTTP path of execution. Path can include query params. Default value is /
`--scheduled-at <scheduled-at>`		Scheduled execution time in ISO 8601 format. DateTime value must be in future with precision in minutes.

create-template-deployment

Bash

revenexx apps create-template-deployment \
    --function-id sample-id \
    --owner sample owner \
    --reference sample reference \
    --repository sample repository \
    --root-directory sample root directory \
    --type commit

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--owner <owner>`		The name of the owner of the template.
`--reference <reference>`		Reference value, can be a commit hash, branch name, or release tag
`--repository <repository>`		Repository name of the template.
`--root-directory <root-directory>`		Path to function code in the template repo.
`--type <type>`		Type for the reference provided. Can be commit, branch, or tag
`--activate [value]`		Automatically activate the deployment when it is finished building.

create-variable

Bash

revenexx apps create-variable \
    --function-id sample-id \
    --key sample key \
    --value sample value

Flag	Required	Description
`--function-id <function-id>`		Function unique ID.
`--key <key>`		Variable key. Max length: 255 chars.
`--value <value>`		Variable value. Max length: 8192 chars.
`--secret [value]`		Secret variables can be updated or deleted, but only functions can read them during build and runtime.

create-vcs-deployment

Bash

revenexx apps create-vcs-deployment \
    --function-id sample-id \
    --reference sample reference \
    --type branch

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--reference <reference>`		VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
`--type <type>`		Type of reference passed. Allowed values are: branch, commit
`--activate [value]`		Automatically activate the deployment when it is finished building.

delete

Bash

revenexx apps delete \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		App ID.

delete-deployment

Bash

revenexx apps delete-deployment \
    --function-id sample-id \
    --deployment-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--deployment-id <deployment-id>`		Deployment ID.

delete-execution

Bash

revenexx apps delete-execution \
    --function-id sample-id \
    --execution-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--execution-id <execution-id>`		Execution ID.

delete-variable

Bash

revenexx apps delete-variable \
    --function-id sample-id \
    --variable-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function unique ID.
`--variable-id <variable-id>`		Variable unique ID.

get

Bash

revenexx apps get \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.

get-deployment

Bash

revenexx apps get-deployment \
    --function-id sample-id \
    --deployment-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--deployment-id <deployment-id>`		Deployment ID.

get-deployment-download

Bash

revenexx apps get-deployment-download \
    --function-id sample-id \
    --deployment-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--deployment-id <deployment-id>`		Deployment ID.
`--type <type>`		Deployment file to download. Can be: "source", "output".

get-execution

Bash

revenexx apps get-execution \
    --function-id sample-id \
    --execution-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--execution-id <execution-id>`		Execution ID.

get-marketplace-status

Bash

revenexx apps get-marketplace-status \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		App ID.

get-template

Bash

revenexx apps get-template \
    --template-id sample-id

Flag	Required	Description
`--template-id <template-id>`		Template ID.

get-usage

Bash

revenexx apps get-usage \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--range <range>`		Date range.

get-variable

Bash

revenexx apps get-variable \
    --function-id sample-id \
    --variable-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function unique ID.
`--variable-id <variable-id>`		Variable unique ID.

install-from-marketplace

Bash

revenexx apps install-from-marketplace \
    --name Sample name \
    --owner sample owner

Flag	Required	Description
`--name <name>`		App name.
`--owner <owner>`		Owner tenant slug of the app being installed.

list

Bash

revenexx apps list

Flag	Required	Description
`--queries [queries...]`		—
`--search <search>`		Search term to filter your list results. Max length: 256 chars.
`--total [value]`		When set to false, the total count returned will be 0 and will not be calculated.
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-deployments

Bash

revenexx apps list-deployments \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--queries [queries...]`		—
`--search <search>`		Search term to filter your list results. Max length: 256 chars.
`--total [value]`		When set to false, the total count returned will be 0 and will not be calculated.
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-executions

Bash

revenexx apps list-executions \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--queries [queries...]`		—
`--total [value]`		When set to false, the total count returned will be 0 and will not be calculated.
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-marketplace

Bash

revenexx apps list-marketplace

Flag	Required	Description
`--search <search>`		Search by app name, title or vendor.
`--per-page <per-page>`		Items per page.
`--page <page>`		Page number.
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-runtimes

Bash

revenexx apps list-runtimes

Flag	Required	Description
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-specifications

Bash

revenexx apps list-specifications

Flag	Required	Description
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-templates

Bash

revenexx apps list-templates

Flag	Required	Description
`--runtimes [runtimes...]`		List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
`--use-cases [use-cases...]`		List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
`--limit <limit>`		Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
`--offset <offset>`		Offset the list of returned templates. Maximum offset is 5000.
`--total [value]`		When set to false, the total count returned will be 0 and will not be calculated.
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-usage

Bash

revenexx apps list-usage

Flag	Required	Description
`--range <range>`		Date range.
`--filter <column=value>`		Filter rows by column equality (repeatable).

list-variables

Bash

revenexx apps list-variables \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function unique ID.
`--filter <column=value>`		Filter rows by column equality (repeatable).

publish

Bash

revenexx apps publish \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		App ID.

unpublish

Bash

revenexx apps unpublish \
    --function-id sample-id

Flag	Required	Description
`--function-id <function-id>`		App ID.

update

Bash

revenexx apps update \
    --function-id sample-id \
    --name Sample name

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--name <name>`		Function name. Max length: 128 chars.
`--commands <commands>`		Build Commands.
`--enabled [value]`		Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
`--entrypoint <entrypoint>`		Entrypoint File. This path is relative to the "providerRootDirectory".
`--events [events...]`		Events list. Maximum of 100 events are allowed.
`--execute [execute...]`		—
`--installation-id <installation-id>`		—
`--logging [value]`		When disabled, executions will exclude logs and errors, and will be slightly faster.
`--provider-branch <provider-branch>`		Production branch for the repo linked to the function
`--provider-repository-id <provider-repository-id>`		Repository ID of the repo linked to the function
`--provider-root-directory <provider-root-directory>`		Path to function code in the linked repo.
`--provider-silent-mode [value]`		Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
`--runtime <runtime>`		Execution runtime.
`--schedule <schedule>`		Schedule CRON syntax.
`--scopes [scopes...]`		List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
`--specification <specification>`		Runtime specification for the function and builds.
`--timeout <timeout>`		Maximum execution time in seconds.

update-deployment

Bash

revenexx apps update-deployment \
    --function-id sample-id \
    --deployment-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--deployment-id <deployment-id>`		Deployment ID.

update-deployment-status

Bash

revenexx apps update-deployment-status \
    --function-id sample-id \
    --deployment-id sample-id

Flag	Required	Description
`--function-id <function-id>`		Function ID.
`--deployment-id <deployment-id>`		Deployment ID.

update-variable

Bash

revenexx apps update-variable \
    --function-id sample-id \
    --variable-id sample-id \
    --key sample key

Flag	Required	Description
`--function-id <function-id>`		Function unique ID.
`--variable-id <variable-id>`		Variable unique ID.
`--key <key>`		Variable key. Max length: 255 chars.
`--secret [value]`		Secret variables can be updated or deleted, but only functions can read them during build and runtime.
`--value <value>`		Variable value. Max length: 8192 chars.

Was this page helpful?