Links
Comment on page

Start scanning using the CLI, Web UI, or API

Ensure that the code in your repositories is in a supported language and platform. For more information, see Supported languages and frameworks.

Prerequisites for scanning applications

Regardless of how you use Snyk, ensure you have completed the steps in the Quickstart.
In addition, if you are using Snyk Code or scanning container images, complete the following:
For general information about Snyk scans, see Running scans.

Overview of ways to scan your Projects

Snyk provides multiple ways to scan Snyk Open Source, Snyk Code, and Snyk Container Projects. You can choose to run your scans from the Web UI, the CLI, the API, or with PR Checks.
Features
Snyk Web UI
Snyk CLI
Snyk API
PR Checks
Auto scanning
Manual scanning
Local scans
Incorporate into the CI/CD pipelines
Obtain results precisely reflecting the Project vulnerabilities and configurations
If you choose to use the CLI for scanning your Snyk Open Source, Snyk Code, and Snyk Container Projects, you can run the scans locally on your machine or incorporate them into your CI/CD pipelines, providing more control and flexibility over the scanning process.
In addition, using the CLI enables you to scan your code, open-source packages, and container images in their specific development environments, ensuring results that precisely reflect the dependencies and configurations of your Projects.

Scan using the CLI

Before initiating a scan using the CLI, ensure you follow all the installation, authentication, and getting started steps:
  • Follow the instructions on the Install or update the Snyk CLI page and choose the installation method that best suits your needs.
  • After the CLI is installed, you must authenticate your machine by following the instructions on the Authentication page.
  • You can test your installation by running snyk --help in the CLI.
  • After the CLI setup in complete, you can start scanning. See Getting started with the CLI for more details.

Initiate a scan

When you scan your Projects using the CLI, you can use a variety of commands and options, some that apply only to Snyk Open Source, Snyk Code, Snyk Container, or Snyk IaC, and others that apply to scanning regardless of the method. For a complete list of Snyk CLI commands and options, see the CLI commands and options summary.
Each Snyk product has specific commands and options. Ensure you are using the correct options and commands for your needs. For information on using the product-specific CLI commands, see the CLI help:
  • Code
  • Container
  • IaC
  • Test for scanning with Snyk Open Source
  • Monitor for monitoring to detect new issues with Snyk Open Source
For more information, see the following pages:

Scan results

After you finish running a Snyk CLI scan, the results are displayed in the terminal. The following pages explain the results for Snyk Open Source, Snyk Code, and Snyk Container scans:

Scan using the Web UI

Using a Snyk integration, you can scan your Projects from the Web UI> Running PR Checks also scans your code. See Configure PR Checks to learn how to enable this functionality. See Run an analysis with Visual Studio Code extension for an example of scanning using an integration.. For more information, see Use Snyk in your IDE and Snyk CI/CD integrations.

Scan using the API

The Snyk API v1 offers a set of endpoints to test your code. See the API v1 Test docs for more information.
Last modified 1mo ago