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.
snyk [COMMAND] [SUBCOMMAND] [OPTIONS] [PACKAGE] [CONTEXT-SPECIFIC-OPTIONS]
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.
To learn more about each Snyk CLI command, use the
--helpoption, for example,
snyk auth --helpor
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.
Authenticate Snyk CLI with a Snyk account.
Test a project for open source vulnerabilities and license issues.
Snapshot and continuously monitor a project for open source vulnerabilities and license issues.
Print a list of the
snyk container monitorand
snyk container test.
Test container images for any known vulnerabilities.
Print a list of the
snyk iac describe,
snyk iac update-exclude-policy, and
snyk iac test.
Detect, track, and alert on infrastructure drift and unmanaged resources.
Generate exclude policy rules to be used by
snyk iac describe.
Test for any known security issue.
Print the name of the snyk codecommand
with its help option: snyk code test
Test for any known security issues using Static Code Analysis.
Find Log4Shell vulnerability.
Manage Snyk CLI configuration.
.snykpolicy for a package.
.snykpolicy to ignore stated issues.
Apply the recommended updates for supported ecosystems automatically.
Create a Snyk App using the Snyk CLI.
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.
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.
-doption to output the debug logs for any command.
Exit codes for the
testcommands 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:
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.
container test, container monitor,
Currently the following options are not supported:
These options are used with the
snyk monitorcommands. See the help docs for
snyk monitorfor details.