CLI commands and options summary

This page only summarizes the CLI commands and the options for each command. For details, use the links in this summary to open the help docs page for the command you are using. The help docs pages are the same as the help in the CLI.

Usage

snyk [COMMAND] [SUBCOMMAND] [OPTIONS] [PACKAGE] [CONTEXT-SPECIFIC-OPTIONS]

Description

The Snyk CLI is a build-time tool to find and fix known vulnerabilities in your projects. For a more detailed description of Snyk CLI and Snyk, see Snyk CLI. For an introduction on how to use the Snyk CLI, see Getting started with the CLI.

Available CLI commands

To learn more about each Snyk CLI command, use the --help option, for example, snyk auth --help or snyk container --help. Each command in this list is linked to the corresponding help page in these docs.

Note: Lists of all the options for Snyk CLI commands are on this page. The options are explained in detail in the help for each command.

`snyk auth`

Authenticate Snyk CLI with a Snyk account.

`snyk config`

Manage Snyk CLI configuration.

`snyk config environment`

Use to set your environment for the region before you run the snyk auth command.

`snyk test`

Test a Project for open-source vulnerabilities and license issues.

`snyk monitor`

Snapshot and continuously monitor a project for open-source vulnerabilities and license issues.

`snyk code`

Print the name of the snyk code command with its help option: snyk code test

`snyk code test`

Test source code for any known security issues (Static Application Security Testing).

`snyk container`

Print a list of the snyk container commands, snyk container monitor and snyk container test.

`snyk container monitor`

Capture the container image layers and dependencies and monitor for vulnerabilities on snyk.io.

`snyk container SBOM`

Generate an SBOM for a container image

`snyk container test`

Test container images for any known vulnerabilities.

`snyk iac`

Print a list of the snyk iac commands: snyk iac describe, snyk iac update-exclude-policy, and snyk iac test.

`snyk iac test`

Test for any known security issue.

`snyk iac capture`

Generate a mapping artifact that contains the minimum amount of information needed to generate resource mappings from code to Cloud from Terraform state files, such as resource IDs and names, and send the mapping artifact to Snyk.

`snyk iac describe`

Detect, track, and alert on infrastructure drift and unmanaged resources.

`snyk iac rules init`

Initialize custom rules project structure, relation, rule, or spec

`snyk iac rules test`

Run tests for all custom rules.

`snyk iac rules push`

Bundle and upload custom rule bundles to Snyk Cloud API.

`snyk iac update-exclude-policy`

Generate exclude policy rules to be used by snyk iac describe.

`snyk ignore`

Modify the .snyk policy to ignore stated issues.

`snyk log4shell`

Find Log4Shell vulnerability.

`snyk policy`

Display the .snyk policy for a package.

`snyk sbom`

Generate an SBOM for a local software project in an ecosystem supported by Snyk.

`snyk sbom test`

Check an SBOM for vulnerabilities in o pen-source packages.

New CLI commands

`snyk fix`

Apply the recommended updates for supported ecosystems automatically. For more information, see Automatic fixing with snyk fix.

`snyk apps`

Create a Snyk App using the Snyk CLI. For more information, see Snyk Apps.

Subcommands of CLI commands

The following is a list of the sub-commands for Snyk CLI commands. Each sub-command is followed by the command(s) to which the sub-command applies. The commands are linked to their help docs. For details concerning each sub-command, see the help docs.

get <KEY>: subcommand of config

set <KEY>=<VALUE>: subcommand of config

unset <KEY>: subcommand of config

clear: subcommand of config

environment: subcommand of config

Configure the Snyk CLI

You can use environment variables to configure the Snyk CLI and also set variables to configure the Snyk CLI to connect with the Snyk API. See Configure the Snyk CLI.

Debug

See Debugging the Snyk CLI for detailed information about the --d option.

Exit codes for CLI commands

Exit codes for the test commands are all the same. See the exit codes in the following help docs:

Additional CLI commands have exit codes as listed in the following help docs:

Options for multiple commands

Lists of the options for Snyk CLI commands follow. Each option is followed by the command(s) to which the option applies. The commands are linked to their help docs. For details concerning each option, see the help docs.

--all-projects: test, monitor,sbom

--fail-fast: test, monitor

--detection-depth=<DEPTH>: test, monitor, iac test, sbom

--exclude=<NAME>[,<NAME>]...>: test, monitor, sbom

--prune-repeated-subdependencies, -p: test, monitor, sbom

--print-deps: test, monitor, container test

--remote-repo-url=<URL>: test, monitor, iac test

--dev: test, monitor, sbom

--org=<ORG_ID>: test, monitor, code test, container test, container monitor, iac test, iac describe, iac capture, sbom, container sbom