Xygeni CLI Installation
Last updated
Last updated
Xygeni CLI can be used either installing it or by using Xygeni CLI Docker Image.
An installation script is provided for automated installation.
The recommended, automated way to install the scanner is to use the installation script.
The Xygeni installation script
is provided by Xygeni
as a way to speed up your xygeni experience by setting your scanning environment as fast as possible.
Run the one of the following which better matches your preferences:
Xygeni publishes a SHA-256 checksum of published components in the , so you may verify the integrity of a downloaded artifact.
To ensure that the downloaded installation script checksum matches the checksum published in Xygeni repository, meaning that probably it was not tampered with:
If under macOS, as sha256sum
is probably not installed in your host, you may:
or use shasum -a 256
instead or sha256sum
if the shasum
command is installed,
or use openssl
to compute the SHA-256 checksum of the installation script and compare it with the published checksum.
If you are using a proxy, you need to include a small change in the execution of the installation script
You should add your proxy as shown below (with the -x
flag). The proxy must be indicated as [PROT]://[HOST]:[PORT]
, for example, http://my_proxy.domain.com:8080
After executing the installation script, in order the scanner to use your proxy you must set the following environment variables :
PROXY_PROTOCOL
(Protocol: "http" or "socks", default value "http" if PROXY_PROTOCOL not set)
PROXY_HOST
(Proxy host)
PROXY_PORT
(Proxy port, default value "3128" if PROXY_PORT not set)
PROXY_AUTH
(Authentication to proxy. One of none or basic)
PROXY_USERNAME
(Proxy username. Ignored with authentication=none)
PROXY_PASSWORD
(Proxy password. Ignored with authentication=none)
NO_PROXY
( Non-proxy hosts. A bar-separated (|) list of hostnames, domain names, IP CIDR ranges, or IP addresses that should bypass the proxy. Use * for all hosts. example.com matches that hostname only, *.example.com matches subdomains. Leave empty for no bypass. Please note that localhost is always bypassed. Example: NO_PROXY=example.com|*.example.com|192.168.0.0/24|10.11.12.13 )
Congratulations, at this point you should have your installation successfully completed.
Now, let’s run your first scan
. Move to your installation directory and execute the command:
to install it,
Active Xygeni account credentials are mandatory to run the script, so make sure you’ve signed up first! Visit or
In what follows, XYGENI_TOKEN
names an environment variable holding the that will be registered in the scanner configuration file for authentication with the service.