qovery environment

Overview

Manage environments and their lifecycle within your Qovery project.

Commands

List Environments

List all environments in current project:

qovery environment list

Flag	Description
`--organization`	Organization Name
`--project`	Project Name
`--json`	JSON output

Deploy Environment

Deploy all services in an environment:

qovery environment deploy --environment "env-name"

Deploy with specific services or versions:

qovery environment deploy \
  --environment "env-name" \
  --applications "app1:commit_id,app2:commit_id" \
  --watch

Flag	Description
`--organization`	Organization Name
`--project`	Project Name
`--environment`	Environment Name
`--services`	Services to deploy (JSON Format: https://api-doc.qovery.com/#tag/Environment-Actions/operation/deployAllServices)
`--applications`	Applications to deploy e.g. `app1:commit_id,app2:commit_id`. Omit commit id to use the same commit. Use `app:latest` to deploy the newest commit of the branch.
`--containers`	Containers to deploy e.g. `container1:image_tag,container2:image_tag`. Omit image tag to use the same tag.
`--lifecycles`	Lifecycle jobs to deploy e.g. `job1:image_tag\|git_commit_id,job2:...`. Omit version to use the same. Use `job:latest` to deploy the newest commit of the branch for a git-sourced job.
`--cronjobs`	Cronjobs to deploy e.g. `cronjob1:git_commit_id,cronjob2:git_commit_id`. Omit commit id to use the same. Use `cronjob:latest` to deploy the newest commit of the branch for a git-sourced cronjob.
`--helms`	Helm charts to deploy e.g. `helm1:chart_version\|git_commit_id,helm2:...`. Omit version to use the same. Use `helm:latest` to deploy the newest commit of the branch for a git-sourced chart.
`--watch` / `-w`	Watch environment status until it’s ready or an error occurs
`--skip-paused-services`	Skip paused services: paused services won’t be started / deployed

Deployment Logs

Print the deployment logs of an environment — the engine output (build, deploy, health checks) shown in the Deployment logs tab of the console. These are the logs of the deployment itself, not the runtime output of a running service. For runtime logs, use qovery log.

qovery environment deployment logs --environment "env-name"

Without --execution-id, the logs of the latest deployment are printed (the API returns at most the last 1000 lines). To read a past deployment, pass its execution ID as listed by qovery environment deployment list:

qovery environment deployment logs \
  --environment "env-name" \
  --execution-id "<execution-id>"

Scope the output to a single service with --service (by name) or --service-id (by UUID); the two are mutually exclusive. Environment-level lines are kept for context:

qovery environment deployment logs --environment "env-name" --service "my-api"

Flag	Description
`--organization`	Organization Name
`--project`	Project Name
`--environment`	Environment Name
`--execution-id` / `--id`	Execution ID of a past deployment, as listed by `qovery environment deployment list` (default: latest deployment)
`--service` / `-s`	Only print the log lines related to that service’s deployment (matched by service name)
`--service-id`	Same as `--service`, matching on the service UUID instead
`--pre-check`	Only print the pre-check log lines (cannot be combined with `--service` or `--service-id`)
`--errors-only`	Only print the log lines carrying an error
`--json`	Print the logs as JSON

The console additionally scopes lines to the deployment stage a service belongs to, which the CLI does not resolve, so a few stage-level lines from other stages may appear in a service-scoped view.

Stop Environment

Stop all services in an environment:

qovery environment stop --environment "env-name"

Flag	Description
`--organization`	Organization Name
`--project`	Project Name
`--environment`	Environment Name
`--watch` / `-w`	Watch environment status until it’s ready or an error occurs

Cancel Environment Deployment

Cancel an ongoing environment deployment:

qovery environment cancel --environment "env-name"

Flag	Description
`--organization`	Organization Name
`--project`	Project Name
`--environment`	Environment Name
`--force` / `-f`	Force cancel
`--watch` / `-w`	Watch environment status until it’s ready or an error occurs

Delete Environment

Delete an environment:

qovery environment delete --environment "env-name"

Flag	Description
`--organization`	Organization Name
`--project`	Project Name
`--environment`	Environment Name
`--watch` / `-w`	Watch environment status until it’s ready or an error occurs

Update Environment

Update an environment’s name or type:

qovery environment update \
  --environment "env-name" \
  --name "new-name"

Flag	Description
`--organization` / `-o`	Organization Name
`--project` / `-p`	Project Name
`--environment` / `-e`	Environment Name
`--name`	New Environment Name
`--type`	Change Environment Type (`DEVELOPMENT\|STAGING\|PRODUCTION`)

Clone Environment

Clone an existing environment:

qovery environment clone \
  --environment "production" \
  --new-environment-name "staging-clone"

Flag	Description
`--organization` / `-o`	Organization Name
`--project` / `-p`	Project Name
`--environment` / `-e`	Environment Name to clone
`--new-environment-name` / `-n`	New Environment Name (required)
`--cluster` / `-c`	Cluster Name where to clone the environment
`--environment-type` / `-t`	Environment type for the new environment (`DEVELOPMENT\|STAGING\|PRODUCTION`)
`--apply-deployment-rule`	Enable applying deployment rules on the new environment instead of having a pristine clone
`--target-project`	Target Project Name

Examples

Deploy Environment

# Set context
qovery context set

# Deploy all services and watch
qovery environment deploy \
  --environment "my-env" \
  --watch

# Deploy specific applications with specific commits
qovery environment deploy \
  --environment "my-env" \
  --applications "api:abc1234,frontend:def5678" \
  --watch

Cancel a Deployment

# Cancel current deployment
qovery environment cancel --environment "my-env"

# Force cancel and watch
qovery environment cancel \
  --environment "my-env" \
  --force \
  --watch

Clone Production to Staging

# Clone environment
qovery environment clone \
  --environment "production" \
  --new-environment-name "staging-test" \
  --environment-type STAGING

# Clone to a different project and cluster
qovery environment clone \
  --environment "production" \
  --new-environment-name "staging-test" \
  --target-project "other-project" \
  --cluster "staging-cluster"

# Deploy cloned environment
qovery environment deploy --environment "staging-test"

Update Environment

# Rename an environment
qovery environment update \
  --environment "old-name" \
  --name "new-name"

# Change environment type
qovery environment update \
  --environment "my-env" \
  --type PRODUCTION

qovery application - Manage applications
qovery database - Manage databases
qovery status - Check environment status

Getting Started

Commands

Troubleshooting

qovery environment

Overview

Commands

List Environments

Deploy Environment

Deployment Logs

Stop Environment

Cancel Environment Deployment

Delete Environment

Update Environment

Clone Environment

Examples

Deploy Environment

Cancel a Deployment

Clone Production to Staging

Update Environment

​Overview

​Commands

​List Environments

​Deploy Environment

​Deployment Logs

​Stop Environment

​Cancel Environment Deployment

​Delete Environment

​Update Environment

​Clone Environment

​Examples

​Deploy Environment

​Cancel a Deployment

​Clone Production to Staging

​Update Environment

​Related Commands

Overview

Commands

List Environments

Deploy Environment

Deployment Logs

Stop Environment

Cancel Environment Deployment

Delete Environment

Update Environment

Clone Environment

Examples

Deploy Environment

Cancel a Deployment

Clone Production to Staging

Update Environment

Related Commands