Apps

Scale an application by changing the VM type or adding/removing regions.

$ reflex cloud apps scale [OPTIONS] APP_ID

• --app-name TEXT: The name of the app.
• --vmtype TEXT: The virtual machine type to scale to.
• --regions, -r TEXT: Region to scale the app to.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --scale-type TEXT: The type of scaling.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Retrieve the status of a specific deployment.

$ reflex cloud apps status [OPTIONS] DEPLOYMENT_ID

• --watch / --no-watch: Whether to continuously watch the status.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Start a stopped application.

$ reflex cloud apps start [OPTIONS] APP_ID

• --app-name TEXT: The name of the application.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Stop a running application.

$ reflex cloud apps stop [OPTIONS] APP_ID

• --app-name TEXT: The name of the application.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Delete an application.

$ reflex cloud apps delete [OPTIONS] APP_ID

• --app-name TEXT: The name of the application.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Retrieve logs for a given application.

$ reflex cloud apps logs [OPTIONS] APP_ID

• --app-name TEXT: The name of the application.
• --token TEXT: The authentication token.
• --offset INTEGER: The offset in seconds from the current time.
• --start INTEGER: The start time in Unix epoch format.
• --end INTEGER: The end time in Unix epoch format.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --cursor TEXT: The cursor for pagination.
• --pretty: Use pretty printing for logs.
• --follow: After printing a page, prompt to fetch the next one. Off by default: the prompt never returns on its own, so a script or an agent that asked for logs would hang instead of exiting.
• --help: Show this message and exit.

Retrieve the deployment history for a given application.

$ reflex cloud apps history [OPTIONS] APP_ID

• --app-name TEXT: The name of the application.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Retrieve the build logs for a specific deployment.

$ reflex cloud apps build-logs [OPTIONS] DEPLOYMENT_ID

• --token TEXT: The authentication token.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

List all the hosted deployments of the authenticated user. Will exit if unable to list deployments.

$ reflex cloud apps list [OPTIONS]

• --project TEXT: The project ID to filter deployments.
• --project-name TEXT: The name of the project.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Roll an app back to a previous deployment.

Redeploys the target deployment's already-built image and makes it current again, without rebuilding from source. DEPLOYMENT_ID is a past deployment from reflex cloud apps history whose "can rollback" is True. Identify the app with --app-id/--app-name or a cloud.yml/pyproject.toml appid.

$ reflex cloud apps rollback [OPTIONS] DEPLOYMENT_ID

• --app-id TEXT: The ID of the application.
• --app-name TEXT: The name of the application.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.

Set or clear the changelog note on a past deployment.

The note is shown in reflex cloud apps history. Identify the app with --app-id/--app-name or a cloud.yml/pyproject.toml appid.

$ reflex cloud apps describe [OPTIONS] DEPLOYMENT_ID

• --description TEXT: The changelog note to set. Pass --description "" to clear it.
• --app-id TEXT: The ID of the application.
• --app-name TEXT: The name of the application.
• --token TEXT: The authentication token.
• --loglevel [debug|default|info|warning|error|critical]: The log level to use.
• --json, -j / --no-json: Output the result as a single JSON document on stdout. Human-readable messages go to stderr instead, so stdout stays parseable.
• --interactive, -i / --no-interactive: Whether to prompt for confirmations and choices. Defaults to on when stdout is a terminal and off otherwise, so a pipe, a CI job or an agent is never left waiting at a prompt.
• --help: Show this message and exit.