Environment variables for Snyk CLI

The environment variables you can use to configure the Snyk CLI

This page identifies environment variables that you can use to configure specific settings for the CLI.

Configure max network attempts

SNYK_MAX_ATTEMPTS

Starting with Snyk CLI v1.1303.2 SNYK_MAX_ATTEMPTS=<value> can be used to enable network level retries. The default value is 1, which means that a network request will fail after one failed attempt. Increasing the value will make the network stack retry retriable status codes. The parameter can be used to mitigate transient network failures at the cost of increased runtime.

The range is from 1 to 2,147,483,648 times.

Alternatively, you can set the value using the command line parameter --max-attempts=<value>.

Configure the CLI Cache folder

SNYK_CACHE_PATH

By specifying the environment variable SNYK_CACHE_PATH, you can define the path to the folder where the CLI will cache files. You must meet the access requirements for the folder specified.

Configure a timeout for CLI operations

SNYK_TIMEOUT_SECS

When you specify an environment variable such as SNYK_TIMEOUT_SECS=60, the CLI will cancel all operations after 60 seconds and exit with exit code 69.

The timeout can range from 1 to 2,147,483,648 seconds, approximately 596.523 hours.

Configure authentication for container registries

SNYK_REGISTRY_USERNAME

For the snyk container commands, specify a USERNAME to use when connecting to a container registry. Note that using the --username option overrides this value. This value is ignored in favor of local Docker binary credentials when Docker is present.

SNYK_REGISTRY_PASSWORD

For the snyk container commands, specify a PASSWORD to use when connecting to a container registry. Note that using the --password option overrides this value. This is ignored in favor of local Docker binary credentials when Docker is present.

Configure CLI settings

You can set the following environment variable to change CLI settings.

SNYK_CFG_<KEY>

By specifying this variable, you can override any key that is also available as a snyk config option.

For example, SNYK_CFG_ORG=myorg overrides the default ORG in config with myorg.