| description |
|---|
Use this documentation to get started with the JetBrains plugin. |
Snyk offers IDE integrations that allow you to use the functionality of Snyk in your Integrated Development Environment. This page describes the Snyk JetBrains plugins. For information about all of the IDE plugins and their use, see Snyk for IDEs in the docs.
Snyk supports JetBrains plugins from version 2020.2 for IntelliJ IDEA and WebStorm as well as Android Studio, AppCode, GoLand, PhpStorm, PyCharm, Rider, and RubyMine.
Snyk uses Python in order to scan and find your dependencies. If you are using multiple Python versions, use the --command option to specify the correct Python command for execution. The plugin does not detect the Python version associated with the project.
The Snyk JetBrains plugins provide analysis of your code, containers, and Infrastructure as Code configurations. The plugin is based on the Snyk CLI and also uses Snyk APIs. The plugin supports product features in the CLI for Snyk Open Source and Snyk Container as well as for Snyk Code and Snyk IaC with some limitations.
Snyk scans for vulnerabilities and misconfigurations and returns results with security issues categorized by issue type and severity.
For open source, you receive automated algorithm-based fix suggestions for both direct and transitive dependencies. For containers, you can automate upgrades to the most secure base image to quickly resolve numerous vulnerabilities. This single plugin provides a Java vulnerability scanner, a custom code vulnerability scanner, an open-source security scanner, and an application security plugin.
Snyk scans for the following types of issues:
Open Source Security - security vulnerabilities and license issues in both direct and in-direct (transitive) open-source dependencies pulled into the Snyk Project. See also the Open Source docs.
Code Security - security vulnerabilities in your code. See also the Snyk Code docs.
Container Security - security vulnerabilities in your base images. See also the Snyk Container docs.
Infrastructure as Code (IaC) Security - configuration issues in your IaC templates: Terraform, Kubernetes, CloudFormation, and Azure Resource Manager. See also the Snyk Infrastructure as Code docs.
The JetBrains plugins also provide the Open Source Advisor to help you find the best package for your next project. Information is provided on the package health of the direct dependencies you are using including popularity, maintenance, risk, and community insights.
After you complete the installation steps on this page and the configuration and authentication steps on the next two pages, continue by following the instructions in the other JetBrains plugins docs:
- Run an analysis with the JetBrains plugins
- JetBrains analysis results: Open Source
- JetBrains analysis results: Snyk Code
- JetBrains analysis results: Snyk IaC Configuration
- JetBrains analysis results: Snyk Container
- How Snyk Container and Kubernetes JetBrains integration works
- Filter JetBrains results
- Troubleshooting for the JetBrains plugin
- For Snyk Open Source, the JetBrains plugin supports the languages and package managers supported by Snyk Open Source and the CLI. For more information, see Supported languages, frameworks, and feature availability overview, Open Source section.
- For Snyk Code, the JetBrains plugin supports all the languages and frameworks supported by Snyk Code. For more information, see Supported languages, frameworks, and feature availability overview, Snyk Code section. Before scanning your repositories with Snyk Code, ensure you have enabled Snyk Code.
- For Snyk Container: the JetBrains plugin supports all the operating system distributions supported by Snyk Container.
- For Snyk IaC, the JetBrains plugin supports the following IaC templates: Terraform, Kubernetes, CloudFormation, and Azure Resource Manager.
Snyk Plugins are not supported on any Operating System that has reached End Of Life (EOL) with the distributor.
You can use the Snyk JetBrains plugin in the following environments:
- Linux: 386, AMD64, and ARM64
- Linux Alpine: 386 and AMD64
- Windows: 386, AMD64, and ARM64
- MacOS: AMD64 and ARM64
The Snyk JetBrains plugin is available for installation on the JetBrains marketplace.
Install using the IDE plugins library:
- Open the Preferences window in the IDE.
- Navigate to the Plugins tab.
- In the Plugins tab, search for Snyk.
- Select the Snyk vulnerability scanning plugin.
- Click on the Install button.
- When the installation is complete, restart the IDE.
 (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1 (7).png)
Select the Snyk vulnerability scanning plugin
Continue with the steps on the JetBrains configuration page.
If you need help, submit a request to Snyk Support.