Xygeni CLI Overview
Last updated
Last updated
Xygeni provides a command-line interface (CLI) for running the scanner. The scanner can either run analysis commands separately, like detecting hardcoded secrets or misconfigurations, or run all the analyses at once. See Available Scanners for a complete list.
The scanner is java program (see Prerequisites and Installation) that can be triggered directly from command line, from any batch program, (Unix shell script, Windows batch, PowerShell script, etc.), from git hooks (pre-commit, pre-receive) or embedded into CI/CD pipelines.
The scanner can be launched to scan a file folder, a container image, a repo or group or repos and even a whole SCM organization.
Scanner findings can be inspected/consumed in the Xygeni Web UI, downloaded via Xygeni REST-API, exported in different formats (csv, json, etc) and also can be notified by creating tickets (Jira, GitHub) or opening team messages (Slack)
The xygeni command-line interface (CLI) is a tool for running scans on software projects, aimed at detecting issues related with the software supply-chain security.
The CLI provides different commands for specific purposes, and is the main tool for integrating Xygeni into DevOps platforms, like source versioning, build, CI/CD and cloud provisioning tools.
xygeni is a general-purpose command that allows you to interact with all the different functionalities.
Basically, it allows to:
authenticate against Xygeni platform (see Xygeni CLI authentication )
specify the general mode of operation [ scan | multi-scan | org-scan ] (see Xygeni CLI mode of operation )
execute any specific scanners [ inventory | deps | malware | ... ] See
ingest data from 3rd-pàrty scanners [ report-upload ] (see Uploading reports from 3rd party tools )
invoke utility functions [ util ] (see CLI utils )
See Xygeni Scanner Reference for a full reference of available commands.
To see the help you can type
