Xygeni CLI Prerequisites

Prerequisites

The following software is required for the Xygeni scanner to work properly

Mac/Linux

• Java 17 or higher

• unzip and curl (only for CLI installation)

• Most scanner commands need git. Version 2.32 or higher is recommended.

Windows

• Java 17 or higher

• PowerShell (only for CLI installation)

• Most scanner commands need git. Version 2.32 or higher is recommended.

It’s important to ensure that the JAVA_HOME environment variable points to the directory where Java is installed, which may or may not be done automatically depending on your platform. Additionally, you need to make sure that the $JAVA_HOME/bin directory is included in your system’s PATH so that you can access the Java executable from anywhere on your system.

Some commands may need additional tools. As dependencies are resolved using the build and package manager tools, the deps and suspectdeps commands require the following tools for the associated ecosystem:

• JavaScript / Node: npm, yarn and bower.

• Python: pip and pipdeptree.

• Java: Apache Maven (mvn).

• Ruby: Ruby Gems (bundle)

• Golang: go toolchain.

• PHP: composer.

• .Net: dotnet.

See Opens Source Scan for full details on the tools required for analyzing the dependencies for each ecosystem.

As Xygeni scans are typically run in CI/CD pipelines, the commands needed are usually the ones used at build time, so normally it is not necessary to install any extra tool in the CI/CD runner. In any case, the Xygeni Scanner Docker image may be used when necessary.

Xygeni Scanner needs connectivity to Xygeni servers.

Please be sure that access is enabled to xygeni.io (https://api.xygeni.io and https://get.xygeni.io).