For the complete documentation index, see llms.txt. This page is also available as Markdown.

Start scanning

How to scan your code with Snyk manually and automatically using the Snyk CLI, web UI, API, and PR Checks

Snyk is rolling out a new navigation. The steps on this page describe the classic interface. If your view looks different, visit Navigate the Snyk Web UI to map these options to the new interface.

Start scanning

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

✔️

✔️

✔️

✔️

You can use Snyk to scan your code manually and automatically using the Snyk CLI, the Snyk web UI, the Snyk API, and by running PR Checks.

Scans (tests) may be limited on your account, depending on your pricing plan. For more information, see What counts as a test?

Scan using the CLI

See Getting started with the CLI for more details.

Use the following Snyk CLI commands for specific scanning methods:

Command
Function
More details

Scan for hard-coded secrets, credentials, and API keys

Scan infrastructure as code (IaC) files

Continually monitor a Project for new vulnerabilities.

Scan using the Web UI

A scan runs when you import a Snyk Project (see Import a Project to scan and identify issues or click Retest now on a Project). Snyk then automatically runs periodic scans on the imported Project to check whether your code is affected by newly disclosed vulnerabilities.

The default scanning frequency and available frequencies vary depending on the type of Project. For more information, see Usage settings.

You can also set the frequency in the Project Settings (see View and edit Project settings) or use the API Endpoint Updates project by project ID.

Scan using the API

The Snyk API offers a set of endpoints to test your code. Scans are counted when calls are made to the test endpoint.

For more information, see the API Test endpoint documentation.

Using PR Checks

Snyk can scan every new Pull Request (PR) submitted on your monitored repositories to help prevent new vulnerabilities from being added to your codebase.

For more information, see Pull Request Checks.

Last updated

Was this helpful?