Getting started with Snyk Code
This section describes how to get started with Snyk Code using the Snyk Web UI Environment.
You can work with Snyk Code using the following Snyk Environments:
The prerequisites for using Snyk Code are the same for all Snyk Environments:
- If you are using the Snyk Web UI, follow the step-by-step instructions in this section to activate and use Snyk Code.
- If you are using the Snyk IDE, CLI, or API Environments, use the Snyk Web UI to enable the Snyk Code option. Then, continue to test your code with Snyk Code in your selected Environment.
To get started with Snyk Code, all you need is a Snyk Account, a supported SCM, and source code that is written in one of the supported platforms and languages.
First, you need to enable the Snyk Code option in your Snyk Org Settings via the Web UI. If you intend on using the IDE, CLI, or API Environments, this is the only step you need to do in order to start working with Snyk Code.
If you are working with the API Environment WITHOUT the CLI, you also need to integrate your SCM via the Web UI
When working with the Snyk Web UI, the next step in the activation process is integrating your Snyk Account with the SCM that contains the repositories you want to test. Then, you can import to your Snyk Account the required repositories, and Snyk Code will automatically analyze them and present to you its analysis results.
During the import process of your selected repositories, Snyk Code automatically analyzes your imported code in search of potential vulnerabilities. All the vulnerability findings that Snyk Code detects in the code of one imported repository, are aggregated in one Snyk Project, called Code analysis:
Note: Unlike other Snyk products, which create a separate Snyk Project for each imported file, Snyk Code creates one Snyk Project for all the imported files of one repository. This way, all the vulnerabilities that were detected in the repository code are aggregated in one Project, and the Snyk Code results can present the data flow of a vulnerability across multiple files.
To view all the security vulnerabilities that Snyk Code detected in your imported code, click the Code analysis Project, and explore the details of each vulnerability:
If your Snyk Account is already integrated with your SCM, and it already contains imported repositories, Snyk Code may be already active and running in your Org Settings. In this case, you can check if your existing repositories are already being tested by Snyk Code, by searching for the Code analysis Project in your Target folders. If a Code analysis Project exists in your imported repositories, you can skip this Getting Started section and move to the Exploring and working with the Snyk Code results section. However, you may want to learn more about the following topics: