snyk library and cli utility
$ npm install snyk
Documentation | Test your project
Snyk helps you find, fix and monitor known vulnerabilities in open source
npm install -g snyk
.snyk auth
For more detail on how to authenticate take a look at the CLI authentication section of the Snyk documentation.
snyk [options] [command] [package]
Run snyk --help
to get a quick overview of all commands or for full details on the CLI read the snyk.io CLI docs.
The package argument is optional. If no package is given, Snyk will run the command against the current working directory allowing you test you non-public applications.
snyk test
on a project either as a one off or as part of your CI process.snyk wizard
and snyk protect
.
snyk wizard
walks you through finding and fixing known vulnerabilities in your project. Remediation options include configuring your policy file to update, auto patch and ignore vulnerabilities. (npm only)snyk protect
your code from vulnerabilities by applying patches and optionally suppressing specific vulnerabilities.snyk monitor
records the state of dependencies and any vulnerabilities on snyk.io so you can be alerted when new vulnerabilities or updates/patches are disclosed that affect your repositories.snyk test
as part of your CI to fail tests when vulnerable Node.js or Ruby dependencies are added.Snyk is also provided as a set of Docker images that carry the runtime environment of each package manager. For example, the npm image will carry all of the needed setup to run npm install
on the currently running container. Currently there are images for npm, Ruby, Maven, Gradle and SBT.
The images can perform snyk test
by default on the specified project which is mounted to the container as a read/write volume, and snyk monitor
if the MONITOR
environment variable is set when running the docker container. If you want an HTML report for test
command, make sure --json
parameter is provided. monitor
command appends it automatically. An HTML file called snyk_report.html
and a CSS file called snyk_report.css
will be generated. The image also writes a file called snyk-res.json
for internal use and snyk-error.log
for errors that we can look at if something goes wrong.
The following environment variables can be used when running the container on docker:
SNYK_TOKEN
- Snyk API token, obtained from https://app.snyk.io/account.USER_ID
- [OPTIONAL] Current user ID on the host machine. If not provided will take the user ID of the currently running user inside the container. This is used for CI builds such as Jenkins where we are running with a non-privileged user and want to allow the user to access the mounted project folder.MONITOR
- [OPTIONAL] If set, tells the image that we want to run snyk monitor
after running snyk test
.PROJECT_FOLDER
- [OPTIONAL] If set, this will cd to the directory inside the mounted project dir to run snyk inside it.ENV_FLAGS
- [OPTIONAL] additional environment parameters to pass to snyk test
when running the container.Docker images are tagged according to the package manager runtime they include, the package manager version and snyk version. The general format of tags is [snyk-version]-[package-manager]-[package-manager-version] or just [package-manager]-[package-manager-version] if we want to use the latest version of snyk. Please see available tags to see the available options.
[snyk-version] - The version of snyk that is installed in the image, if version is omitted it will use the latest version. [package-manager] - One of the available package managers (e.g: npm, mvn, gradle, etc...). [package-manager-version] - The version of the package manager that is installed inside the image.
Please see the following examples on how to run Snyk inside docker:
We will need to mount the project root folder when running the image so that Snyk can access the code within the container. The host project folder will be mounted to /project
on the container and will be used to read the dependencies file and write results for CI builds. Here's an example of running snyk test
and snyk monitor
in the image (with the latest version of Snyk) for npm:
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
snyk/snyk-cli:npm test --org=my-org-name
We will need to mount the project root folder when running the image so that Snyk can access the code within the container. The host project folder will be mounted to /project
on the container and will be used to read the dependencies file and write results for CI builds. Here's an example of running snyk test
and snyk monitor
in the image (with the latest version of Snyk) for RubyGems:
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
snyk/snyk-cli:rubygems test --org=my-org-name
We will need to mount the project root folder when running the image so that Snyk can access the code within the container and mount the local .m2 and .ivy2 folders. The host project folder will be mounted to /project
on the container and will be used to read the dependencies file and write results for CI builds. Here's an example of running snyk test
and snyk monitor
in the image (with the latest version of Snyk) for Maven:
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
-v "/home/user/.m2:/home/node/.m2"
-v "/home/user/.ivy2:/home/node/.ivy2"
snyk/snyk-cli:maven-3.5.4 test --org=my-org-name
We will need to mount the project root folder when running the image so that Snyk can access the code within the container and mount the local .m2 and .ivy2 folders. The host project folder will be mounted to /project
on the container and will be used to read the dependencies file and write results for CI builds. Here are examples of running snyk test
and snyk monitor
in the image (with the latest version of Snyk) for SBT:
NOTE: the dependency-tree
module is required for snyk
to process Scala projects. Use version 0.8.2 for SBT 0.13.16 and version 0.9.0 for version SBT 1.0.4.
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
-v "/home/user/.m2:/home/node/.m2"
-v "/home/user/.ivy2:/home/node/.ivy2"
snyk/snyk-cli:sbt-0.13.16 test --org=my-org-name
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
-v "/home/user/.m2:/home/node/.m2"
-v "/home/user/.ivy2:/home/node/.ivy2"
snyk/snyk-cli:sbt-1.0.4 test --org=my-org-name
We will need to mount the project root folder when running the image so that Snyk can access the code within the container and mount the local .m2 and .ivy2 folders. The host project folder will be mounted to /project
on the container and will be used to read the dependencies file and write results for CI builds. Here's an example of running snyk test
and snyk monitor
in the image (with the latest version of Snyk) for Gradle:
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
-v "/home/user/.m2:/home/node/.m2"
-v "/home/user/.ivy2:/home/node/.ivy2"
snyk/snyk-cli:gradle-2.8 test --org=my-org-name
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
-v "/home/user/.m2:/home/node/.m2"
-v "/home/user/.ivy2:/home/node/.ivy2"
snyk/snyk-cli:gradle-4.4 test --org=my-org-name
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
-v "/home/user/.m2:/home/node/.m2"
-v "/home/user/.ivy2:/home/node/.ivy2"
snyk/snyk-cli:gradle-5.4 test --org=my-org-name
We will need to mount the project root folder when running the image so that Snyk can access the code within the container and Docker socket so that Snyk can access Docker daemon. The host project folder will be mounted to /project
on the container and will be used to read the Docker file (with --file). Here's an example of running snyk test
and snyk monitor
in the image (with the latest version of Snyk) for Docker:
docker run -it
-e "SNYK_TOKEN=<TOKEN>"
-e "USER_ID=1234"
-e "MONITOR=true"
-v "<PROJECT_DIRECTORY>:/project"
-v "/var/run/docker.sock:/var/run/docker.sock"
snyk/snyk-cli:docker test --docker myapp:mytag --file=<DOCKERFILE>
Make users feel more confident in using your website by adding your Snyk badge!
[![Known Vulnerabilities](https://snyk.io/package/npm/snyk/badge.svg)](https://snyk.io/package/npm/snyk)
© 2010 - cnpmjs.org x YWFE | Home | YWFE