# Xygeni CLI Prerequisites

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

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

{% tabs %}
{% tab title="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.
  {% endtab %}

{% tab title="Windows" %}

* `Java 17 or higher`
* `PowerShell` (only for CLI installation)
* Most scanner commands need `git`. Version 2.32 or higher is recommended.
  {% endtab %}
  {% endtabs %}

{% hint style="warning" %}
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.
{% endhint %}

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](/xygeni-products/open-source-security-oss/dependency-scanner.md) for full details on the tools required for analyzing the dependencies for each ecosystem.

{% hint style="info" %}
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](/xygeni-scanner-cli/xygeni-cli-overview/xygeni-cli-docker-image.md) may be used when necessary.
{% endhint %}

{% hint style="info" %}
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>).
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xygeni.io/xygeni-scanner-cli/xygeni-cli-overview/xygeni-cli-prerequisites.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
