Xygeni Scanner GUI
Prerequisites
Please take a look to the prerequisites of the scanner as the GUI will use this scanner in background https://docs.xygeni.io/~/revisions/E1kODwIKT7vAbBhutwlZ/xygeni-scanner-cli/xygeni-cli-overview/xygeni-cli-prerequisites
How to Install
The following software is required for the Xygeni scanner to work properly
Use the sudo apt install command with the "XygeniLocalScanner.deb" file
Open a terminal
Use the new command XygeniLocalScanner
Execute the "XygeniLocalScanner.msi" file
Customize the installation according to your preferences
Go to the Search bar and search "XygeniLocalScanner"
Open the application
How to use
Xygeni Local Scanner use is the same in Linux, Windows and Mac, so this guide applies to all operating systems.
Installation Screen
Xygeni Local Scanner checks whether the Xygeni CLI Scanner is already installed. It first looks for it as a program available in the system PATH. If it is not found, it then searches in the user’s home directory under .XygeniLocalScanner/xygeni_scanner. If the scanner is not present in either of these two locations, it will be downloaded automatically, and the following screen will be displayed.
This screen appears when the Xygeni CLI Scanner is not detected on the system. It includes a help button that redirects the user to this guide, a status message that updates dynamically to inform the user about the current progress, and an animated loading spinner that shows the application is still running. When the dowload is completed, this screen will change automatically to the following screen.
Main Screen
Xygeni Token
The Xygeni Token field represents the authentication token used to authenticate with the Xygeni server. By default, the token is masked and displayed as dots to protect sensitive information. An eye-icon button allows the user to toggle the token’s visibility on demand.
The application performs real-time validation of the token by calling Xygeni’s internal API. This API uses the XYGENI_URL environment variable; if the variable is not defined, the default endpoint https://api.xygeni.io is used.
The field is highlighted red when the token is invalid, and green when the token has been successfully validated.
Location and name selector
This section allows the user to choose where the code to be analyzed is located:
Local Directory: Allows the user to specify a local directory. It also enables a folder icon button that opens a directory selection dialog.
Remote SCM: Allows the user to specify a repository hosted in a remote source control management system.
If the selected directory or repository URL is invalid, the corresponding input field is highlighted red.
The Application Name field is optional and allows the user to assign a custom name to the project as it will appear in the Xygeni dashboard.
(Optional) Customize the Scan
This dropdown contains the full list of available Xygeni analyzers. Each analyzer has its own checkbox so the user can select which analyses to execute during the scan.
All analyzers are enabled by default.
Launch the scan
To start a scan, the user must fill in at least the following:
A valid Xygeni Token
A local directory path or a remote repository URL
Also, at least one analyzer must be enabled.
Once the required fields are provided, the user can initiate the process by clicking the Launch Scan button.
Access to the results
A dedicated output area displays the scanner logs in real time as the analysis progresses.
When the scan completes successfully, the Open Results button becomes enabled. Clicking this button opens the Xygeni dashboard in the default web browser, showing the results for the project that has just been analyzed
Other functionalities
This screen also counts with a help button that will open this guide on the default browser.
Main Screen after launching an Scan
Last updated