Links

Visual Studio Code extension configuration

Environment variables

To analyze projects, the plugin uses the Snyk CLI which requires environment variables:
  • PATH: the path to needed binaries, for example, to maven
  • JAVA_HOME: the path to the JDK you want to use to analyze Java dependencies
Setting these variables only in a shell environment (for example, using ~/.bashrc) is not sufficient, if you do not start the IDE from the command line or create a script file that starts the IDE using a shell environment.
  • On Windows, you can set the variables using the GUI or on the command line using the setx tool.
  • On macOS, the process launchd must know the environment variables to launch the IDE from Finder directly. You can set environment variables for applications launched using Finder by using the launchctl setenv command, for example, on start-up or through a script you launch at user login. Note: The provision of environment variables to the macOS UI can change between operating system releases, so it may be easier to create a small shell script that launches the IDE to leverage the shell environment that can be defined via ~/.bashrc.
  • On Linux, updating the file /etc/environment can propagate the environment variables to the windows manager and UI.

Proxy

If you are behind a proxy, configure the proxy settings using VS Code proxy settings or set the proxy settings using http_proxy and https_proxy environment variables.

Visual Studio Code extension configuration

After the extension is installed, you can set the following configurations for the extension:
  • Features
    • Code Security: configure if code security analysis should run over your code.
    • Code Quality: configure if code quality analysis should run over your code.
    • Open Source Security: configure if security analysis should run over your open source dependencies.
    • Infrastructure as Code: configure if security analysis should run over your IaC configuration files.
  • Severity: set severity level to display in the analysis result tree.
  • Crash Report: send error reports to Snyk.
  • Telemetry: send usage statistics to Snyk.
  • Advanced
    • Advanced mode: toggle a panel to allow the user to manually control when the analysis should be run.
    • Auto Scan Open Source Security: run Snyk Open Source analysis in automatic mode.
    • Additional Parameters: set additional snyk test CLI options for the Open Source scanning. For unmanaged C/C++ scanning, use the CLI option --unmanaged to find vulnerabilities in open source packages. This option works only for unmanaged C/C++ scanning; do not use this option for other languages. Additional parameters do not apply to Snyk Code or IaC.
    • Organization: specify an organization slug name to run tests for that organization. The value of organization setting snyk.advanced.organization must match the URL slug as displayed in the URL of your org in the Snyk UI: https://app.snyk.io/org/[orgslugname]. If not specified, the preferred organization as defined in your web account settings is used to run tests.
    • Custom endpoint: specify the custom Snyk API endpoint for your organization. Use this field for the custom endpoint for Single Tenant setups as well instead of https://app.snyk.io.
    • Automatic Dependency Management and Cli Path: uncheck to opt out of downloading the CLI through the plugin and thus use your own installation of the CLI. Snyk recommends recommends always using the most recent version of the CLI.
      • When Automatic Dependency Management is checked, the plugin will automatically download and keep the CLI updated.
      • When Automatic Dependency Management __ is checked __ and Cli Path contains a path, the plugin uses the provided CLI path. Use this option if downloading the CLI is not possible due to your network configuration (for example, due to firewall rules) and you need to obtain the CLI through other means.
        Automatic Dependency Management and CLI Path
        Automatic Dependency Management and CLI Path
© 2022 Snyk Limited