Skip to main content

environment

Manage Saleor Cloud environments

environment

$ saleor environment --help

Help output:

saleor environment [command]

Manage Saleor Cloud environments

Commands:
saleor environment auth [key|environment] Manage basic auth for a specific environment
saleor environment clear <key|environment> Clear database for an environment
saleor environment cors [key|environment] Manage environment's CORS
saleor environment create [name] Create a new environment
saleor environment list List environments
saleor environment maintenance [key|environment] Enable or disable maintenance mode in a specific environment
saleor environment origins [key|environment] Manage the environment's trusted client origins
saleor environment populate [key|environment] Populate database for an environment
saleor environment promote [key|environment] Promote environment to production
saleor environment remove [key|environment] Delete an environment
saleor environment show [key|environment] Show a specific environment
saleor environment switch [key|environment] Make the provided environment the default one
saleor environment update [key|environment] Update the name of the environment
saleor environment upgrade [key|environment] Upgrade a Saleor version in a specific environment

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]
Expand ▼

environment auth

$ saleor environment auth --help

Help output:

saleor environment auth [key|environment]

Manage basic auth for a specific environment

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--login basic auth login of the environment [string]
--password, --pass basic auth password of the environment [string]
--disable disable basic auth for the environment [boolean]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

Examples:
saleor env auth
saleor env auth my-environment
saleor env auth my-environment --login=saleor --password=saleor
saleor env auth my-environment --disable
Expand ▼

environment clear

$ saleor environment clear --help

Help output:

saleor environment clear <key|environment>

Clear database for an environment

Positionals:
key, environment key of the environment [string] [required]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

Examples:
saleor env clear my-environment
saleor env clear my-environment --organization="organization-slug"

environment cors

$ saleor environment cors --help

Help output:

saleor environment cors [key|environment]

Manage environment's CORS

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--all All origins are allowed [boolean]
--dashboard Only dashboard is allowed [boolean]
--selected Only specified origins are allowed [array]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

Examples:
saleor env cors
saleor env cors my-environment --all
saleor env cors my-environment --dashboard
saleor env cors my-environment --selected="https://example.com"
Expand ▼

environment create

$ saleor environment create --help

Help output:

saleor environment create [name]

Create a new environment

Positionals:
name name for the new environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--project create this environment in this project [string]
--database specify how to populate the database [string]
--saleor specify the Saleor version [string]
--domain specify the domain for the environment [string]
--login specify the API Basic Auth login [string]
--pass specify the API Basic Auth password [string]
--restore-from specify snapshot id to restore the database from [string]
--skip-webhooks-update use with `restore-from` option, skip webhooks update prompt when restoring from snapshot [boolean]
--skip-restrict skip Basic Auth restriction prompt [boolean]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

Examples:
saleor env create my-environment
saleor env create my-environment --project="project-name" --database="sample" --saleor="saleor-master-staging" --domain="project-domain" --skip-restrict
saleor env create my-environment --organization="organization-slug" --project="project-name" --database="sample" --saleor="saleor-master-staging" --domain="project-domain" --skip-restrict
Expand ▼

environment list

$ saleor environment list --help

Help output:

saleor environment list

List environments

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--extended show extended table [boolean] [default: false]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

environment maintenance

$ saleor environment maintenance --help

Help output:

saleor environment maintenance [key|environment]

Enable or disable maintenance mode in a specific environment

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--enable enable maintenance mode [boolean]
--disable disable maintenance mode [boolean]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

Examples:
saleor env maintenance
saleor env maintenance my-environment
saleor env maintenance my-environment --enable
saleor env maintenance my-environment --disable
Expand ▼

environment origins

$ saleor environment origins --help

Help output:

saleor environment origins [key|environment]

Manage the environment's trusted client origins

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--origins Allowed domains [array]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

Examples:
saleor env origins
saleor env origins my-environment --origins=https://trusted-origin.com

environment populate

$ saleor environment populate --help

Help output:

saleor environment populate [key|environment]

Populate database for an environment

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

environment promote

$ saleor environment promote --help

Help output:

saleor environment promote [key|environment]

Promote environment to production

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--saleor specify the Saleor version [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

environment remove

$ saleor environment remove --help

Help output:

saleor environment remove [key|environment]

Delete an environment

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--force skip confirmation prompt [boolean]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

environment show

$ saleor environment show --help

Help output:

saleor environment show [key|environment]

Show a specific environment

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

environment switch

$ saleor environment switch --help

Help output:

saleor environment switch [key|environment]

Make the provided environment the default one

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

environment update

$ saleor environment update --help

Help output:

saleor environment update [key|environment]

Update the name of the environment

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
--name name of the environment [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]

Examples:
saleor env update
saleor env update my-environment
saleor env update my-environment --name=renamed-env
Expand ▼

environment upgrade

$ saleor environment upgrade --help

Help output:

saleor environment upgrade [key|environment]

Upgrade a Saleor version in a specific environment

Positionals:
key, environment key of the environment [string]

Options:
--json Output the data as JSON [boolean] [default: false]
--short Output data as text [boolean] [default: false]
-u, --instance, --url Saleor instance API URL (must start with the protocol, i.e. https:// or http://) [string]
-V, --version Show version number [boolean]
-h, --help Show help [boolean]