Sites commands
Reference for the `revenexx sites` 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.
Every revenexx sites 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 sites <command> --help for the live options.
create
Bash
revenexx sites create \
--build-runtime node-18.0 \
--framework analog \
--name Sample name \
--site-id sample-id
| Flag | Required | Description |
|---|---|---|
--build-runtime <build-runtime> | Runtime to use during build step. | |
--framework <framework> | Sites framework. | |
--name <name> | Site name. Max length: 128 chars. | |
--site-id <site-id> | Site ID. Choose a custom ID or generate a random ID with \ | |
--adapter <adapter> | Framework adapter defining rendering strategy. Allowed values are: static, ssr | |
--build-command <build-command> | Build Command. | |
--enabled [value] | Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled. | |
--fallback-file <fallback-file> | Fallback file for single page application sites. | |
--install-command <install-command> | Install Command. | |
--installation-id <installation-id> | — | |
--logging [value] | When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. | |
--output-directory <output-directory> | Output Directory for site. | |
--provider-branch <provider-branch> | Production branch for the repo linked to the site. | |
--provider-repository-id <provider-repository-id> | Repository ID of the repo linked to the site. | |
--provider-root-directory <provider-root-directory> | Path to site 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 site? In silent mode, comments will not be made on commits and pull requests. | |
--specification <specification> | Framework specification for the site and builds. | |
--timeout <timeout> | Maximum request time in seconds. |
create-deployment
Bash
revenexx sites create-deployment \
--site-id sample-id \
--activate true \
--code 'path/to/file.png'
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--activate <activate> | Automatically activate the deployment when it is finished building. | |
--code <code> | — | |
--build-command <build-command> | Build Commands. | |
--install-command <install-command> | Install Commands. | |
--output-directory <output-directory> | Output Directory. |
create-duplicate-deployment
Bash
revenexx sites create-duplicate-deployment \
--site-id sample-id \
--deployment-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--deployment-id <deployment-id> | Deployment ID. |
create-template-deployment
Bash
revenexx sites create-template-deployment \
--site-id sample-id \
--owner sample owner \
--reference sample reference \
--repository sample repository \
--root-directory sample root directory \
--type branch
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site 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 site 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 sites create-variable \
--site-id sample-id \
--key sample key \
--value sample value
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site 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 sites can read them during build and runtime. |
create-vcs-deployment
Bash
revenexx sites create-vcs-deployment \
--site-id sample-id \
--reference sample reference \
--type branch
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site 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 sites delete \
--site-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. |
delete-deployment
Bash
revenexx sites delete-deployment \
--site-id sample-id \
--deployment-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--deployment-id <deployment-id> | Deployment ID. |
delete-log
Bash
revenexx sites delete-log \
--site-id sample-id \
--log-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--log-id <log-id> | Log ID. |
delete-variable
Bash
revenexx sites delete-variable \
--site-id sample-id \
--variable-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site unique ID. | |
--variable-id <variable-id> | Variable unique ID. |
get
Bash
revenexx sites get \
--site-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. |
get-deployment
Bash
revenexx sites get-deployment \
--site-id sample-id \
--deployment-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--deployment-id <deployment-id> | Deployment ID. |
get-deployment-download
Bash
revenexx sites get-deployment-download \
--site-id sample-id \
--deployment-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--deployment-id <deployment-id> | Deployment ID. | |
--type <type> | Deployment file to download. Can be: "source", "output". |
get-log
Bash
revenexx sites get-log \
--site-id sample-id \
--log-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--log-id <log-id> | Log ID. |
get-variable
Bash
revenexx sites get-variable \
--site-id sample-id \
--variable-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site unique ID. | |
--variable-id <variable-id> | Variable unique ID. |
list
Bash
revenexx sites 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 sites list-deployments \
--site-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site 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-frameworks
Bash
revenexx sites list-frameworks
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |
list-logs
Bash
revenexx sites list-logs \
--site-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site 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-specifications
Bash
revenexx sites list-specifications
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |
list-variables
Bash
revenexx sites list-variables \
--site-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site unique ID. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
update
Bash
revenexx sites update \
--site-id sample-id \
--framework analog \
--name Sample name
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--framework <framework> | Sites framework. | |
--name <name> | Site name. Max length: 128 chars. | |
--adapter <adapter> | Framework adapter defining rendering strategy. Allowed values are: static, ssr | |
--build-command <build-command> | Build Command. | |
--build-runtime <build-runtime> | Runtime to use during build step. | |
--enabled [value] | Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled. | |
--fallback-file <fallback-file> | Fallback file for single page application sites. | |
--install-command <install-command> | Install Command. | |
--installation-id <installation-id> | — | |
--logging [value] | When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. | |
--output-directory <output-directory> | Output Directory for site. | |
--provider-branch <provider-branch> | Production branch for the repo linked to the site. | |
--provider-repository-id <provider-repository-id> | Repository ID of the repo linked to the site. | |
--provider-root-directory <provider-root-directory> | Path to site 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 site? In silent mode, comments will not be made on commits and pull requests. | |
--specification <specification> | Framework specification for the site and builds. | |
--timeout <timeout> | Maximum request time in seconds. |
update-deployment-status
Bash
revenexx sites update-deployment-status \
--site-id sample-id \
--deployment-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--deployment-id <deployment-id> | Deployment ID. |
update-site-deployment
Bash
revenexx sites update-site-deployment \
--site-id sample-id \
--deployment-id sample-id
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site ID. | |
--deployment-id <deployment-id> | Deployment ID. |
update-variable
Bash
revenexx sites update-variable \
--site-id sample-id \
--variable-id sample-id \
--key sample key
| Flag | Required | Description |
|---|---|---|
--site-id <site-id> | Site 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 sites can read them during build and runtime. | |
--value <value> | Variable value. Max length: 8192 chars. |