Getting started with the CLI

The Snyk Command Line Interface (CLI) helps you find and fix known vulnerabilities in your dependencies, both manually and as part of your Continuous Integration (CI) build system.

See Language Support for details about package managers and languages that the CLI supports.

Install and authenticate the Snyk CLI

  1. Install the Snyk CLI using npm, Homebrew, Scoop or a manual installer from Snyk’s GitHub. See Install the Snyk CLI.

  2. To associate your Snyk account with the CLI, authenticate your account, either through your browser or using your API token. See Authenticate the CLI with your account.

Build your project

Before testing for vulnerabilities you must build your project, unless it has one of the following lock files:

  • package-lock.json

  • yarn.lock

  • Gemfile.lock

  • paket.lock

Gradle projects do not require a full build when external Gradle files where declared dependencies versions exist in the project already. In that case, all that is required is the following:

  • build.gradle

  • All other files that declare dependencies

Examples of how to build/install your project:

npm install mvn install gradle build dotnet restore dep ensure

Test for vulnerabilities

Once installed and authenticated, change directory into a folder containing a supported package manifest file (package.json, pom.xml, composer.lock, etc.) and run:

cd /my/project/

snyk test

All vulnerabilities identified are listed, including their path, and remediation guidance. To monitor your project regularly and receive ongoing notifications when new vulnerabilities are introduced, see Monitor your projects at regular intervals.

Monitor your project

Snyk uses monitoring to regularly test your code and notify you when new vulnerabilities are introduced. To set up your project to be monitored:

  1. Open a terminal from your project directory and run snyk monitor.

    This command takes a snapshot of your current dependencies so Snyk can regularly scan your code, and notify you about newly disclosed vulnerabilities as they are introduced, or when a previously unavailable patch or upgrade path is created.

  2. Log in to the Snyk app and navigate to the Projects page to see the latest snapshot and scan results.

What's next

Run snyk help or see Our full CLI reference.

We also have a handy cheat sheet available and a video tutorial.

Ready to get started with Snyk? Sign up for free!