env

Control environment variables for the current site

Usage

netlify env

Flags

• filter (string) - For monorepos, specify the name of the application to run the command in
• debug (boolean) - Print debugging information

Examples

netlify env:list
netlify env:get VAR_NAME
netlify env:set VAR_NAME value
netlify env:unset VAR_NAME
netlify env:import fileName
netlify env:clone --to <to-site-id>

env:clone

Clone environment variables from one site to another

Usage

netlify env:clone

Flags

• filter (string) - For monorepos, specify the name of the application to run the command in
• force (boolean) - Bypasses prompts & Force the command to run.
• from (string) - Site ID (From)
• to (string) - Site ID (To)
• debug (boolean) - Print debugging information

Examples

netlify env:clone --to <to-site-id>
netlify env:clone --to <to-site-id> --from <from-site-id>

env:get

Get resolved value of specified environment variable (includes netlify.toml)

Usage

netlify env:get

Arguments

• name - Environment variable name

Flags

• context (string) - Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")
• filter (string) - For monorepos, specify the name of the application to run the command in
• scope (builds | functions | post-processing | runtime | any) - Specify a scope
• debug (boolean) - Print debugging information

Examples

netlify env:get MY_VAR # get value for MY_VAR in dev context
netlify env:get MY_VAR --context production
netlify env:get MY_VAR --context branch:staging
netlify env:get MY_VAR --scope functions

env:import

Import and set environment variables from .env file

Usage

netlify env:import

Arguments

• fileName - .env file to import

Flags

• filter (string) - For monorepos, specify the name of the application to run the command in
• replace-existing (boolean) - Replace all existing variables instead of merging them with the current ones
• debug (boolean) - Print debugging information

env:list

Lists resolved environment variables for site (includes netlify.toml)

Usage

netlify env:list

Flags

• context (string) - Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")
• filter (string) - For monorepos, specify the name of the application to run the command in
• json (boolean) - Output environment variables as JSON
• plain (boolean) - Output environment variables as plaintext
• scope (builds | functions | post-processing | runtime | any) - Specify a scope
• debug (boolean) - Print debugging information

Examples

netlify env:list # list variables with values in the dev context and with any scope
netlify env:list --context production
netlify env:list --context branch:staging
netlify env:list --scope functions
netlify env:list --plain

env:set

Set value of environment variable

Usage

netlify env:set

Arguments

• key - Environment variable key
• value - Value to set to

Flags

• context (string) - Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev") (default: all contexts)
• filter (string) - For monorepos, specify the name of the application to run the command in
• force (boolean) - Bypasses prompts & Force the command to run.
• scope (builds | functions | post-processing | runtime) - Specify a scope (default: all scopes)
• secret (boolean) - Indicate whether the environment variable value can be read again.
• debug (boolean) - Print debugging information

Examples

netlify env:set VAR_NAME value # set in all contexts and scopes
netlify env:set VAR_NAME value --context production
netlify env:set VAR_NAME value --context production deploy-preview
netlify env:set VAR_NAME value --context production --secret
netlify env:set VAR_NAME value --scope builds
netlify env:set VAR_NAME value --scope builds functions
netlify env:set VAR_NAME --secret # convert existing variable to secret

env:unset

Unset an environment variable which removes it from the UI

Usage

netlify env:unset

Arguments

• key - Environment variable key

Flags

• context (string) - Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev") (default: all contexts)
• filter (string) - For monorepos, specify the name of the application to run the command in
• force (boolean) - Bypasses prompts & Force the command to run.
• debug (boolean) - Print debugging information

Examples

netlify env:unset VAR_NAME # unset in all contexts
netlify env:unset VAR_NAME --context production
netlify env:unset VAR_NAME --context production deploy-preview