Snyk CLI for Snyk Code

The Snyk Command Line Interface (CLI) enables you to bring the functionality of Snyk Code into your development workflow. Using the Snyk CLI, you can run Snyk Code tests locally or incorporate them into your CI/CD pipeline to scan your source code for security vulnerabilities.

Prerequisites for using the Snyk CLI with Snyk Code

Before using the Snyk CLI for testing your source code with Snyk Code, verify you have the following prerequisites:

• A Snyk account. For more information, see Create a Snyk account.

• Repositories with code in a supported language and framework. For more information, see Snyk Code - Supported languages and frameworks.

• The Snyk Code option enabled in your Snyk Org settings.

• The Snyk CLI installed and authenticated.

  • For instructions, see Install or update the Snyk CLI and Authenticate the Snyk CLI.

  • The minimum Snyk CLI version for Snyk Code, version 1.716.0. Snyk recommends using the latest version of the CLI.

Using the Snyk CLI for Snyk Code tests

To test your repository code using the Snyk CLI, use the snyk code test command. For more information, see Scan source code with Snyk Code using the CLI.

Before running Snyk Code tests with the CLI, you may want to do the following:

• Update your Snyk CLI version.

• Set the Organization for the CLI tests.

• Exclude directories and files from the Snyk Code test.

For information about using the snyk code test command and the results, see the pages in this section of the documentation and snyk-to-html.