release environments create

Command reference doc for the Release CLI

Create an ephemeral environment and automatically deploy it (by default)

Description

Create an ephemeral environment for the given application.

Unless the --skip-deploy flag is passed, the environment will be automatically deployed.

If the --wait flag is passed, the command will exit with a non-zero exit code if the deploy fails.

If image overrides are specified, they will be used instead of the default built images for the service.

It is possible to override the default environment variables by using the --env-vars flag.

Environment variables may be set by using the --env-vars flag. To set an environment variable for all jobs and services, use the syntax "KEY=VALUE". To override a variable for a specific service use the syntax "services.my-service-name.KEY=VALUE".

release environments create [flags]

Examples

Create a new ephemeral environment and trigger a deployment asynchronously:
> release environments create

Create a new ephemeral environment without deploying it:
> release environments create --skip-deploy

Create a new ephemeral environment and wait until it is deployed before exiting:
> release environments create --app backend --wait

Stream deployment logs to stderr while deploying:
> release environments create --app backend --wait --verbose

Get environment details as JSON:
> release environments create --app backend --branch main --wait --verbose -o json > ./environment.json

Override default image for a service:
> release environments create --app backend --image-overrides api=myrepo/api:latest,worker=myrepo/worker:latest

Override environment variables:
> release environments create --app backend --env-vars DB_URL=postgres://host/db,services.api.NODE_ENV=test

Alternative syntax supporting quoted values:
> release environments create --app backend --env-vars "FOO=value with spaces" --env-vars "BAR=value with spaces"

Options

--account <string>	Account name or ID (default: $RELEASE_ACCOUNT or "account" in config file)
--app <string>	App name or ID (default: $RELEASE_APP or "app" in config file)
--branch <string>	Branch name to track
--context <string>	Name of the cluster to deploy the environment to (overrides default context from Application Template)
--domain <string>	Domain to use for this environment's public URLs (overrides default domain from Application Template)
--env-vars <stringToString>	One or more comma separated env var pairs (example: defaults.MY_VAR1=x,services.api.MY_VAR2=y
--image-overrides <stringToString>	One or more comma separated service image overrides pairs. example: api=myrepo/api:latest,worker=myrepo/worker:latest
-o, --output <string>	Set the output format (table | json | json-pretty)
--skip-deploy	Skip deploying the newly created environment
--verbose	Verbose log output
--wait	Wait for environment deploy to complete before exiting

Options inherited from parent commands

--config <string>	config file (default is $HOME/.release.yaml)
--debug	enable debug logging

Related

• release environments - Manage environments