< Back to all manuals

Xcalscan User Manual (Release 2.0.0)

Xcalscan User Manual (Release 2.0.0)

Installing the Client

4.0 Installing the Client for Xcalscan

latest update: 2021-06-24

Xcalclient is typically installed by Xcalibyte’s technical support team. However, in the event that you need to install it yourself then please follow these instructions.

  1. For projects that are written in Java:

– Install JDK & Setup JAVA_HOME

– Install Maven & Setup MAVEN_HOME(M2_HOME)

  1. For projects that are written in C/C++:

– Installation of an additional library is not required

  1. Follow these instructions to install Xcalclient on the local computer.
      • Xcalclient can be downloaded from Xcalibyte’s Partner Portal located at Xcalibyte.com. To access the partner portal you will need a username and password that can be provided by your Xcalibyte account manager or by contacting Xcalibyte Technical Support at support@xcalibyte.com.
      • Locate the Xcalclient download package of Xcalscan in the Application Download section of the partner portal.
      • Unzip and open the Xcalclient package.
      • Run Xcalclientsetup with $ ./setup (Linux) or click setup.exe (Windows).


Follow the instructions and answer the questions in the console. Installation is completed when it says Xcalclient has started and its location is shown.



Xcalclient’s path can be entered and modified in SETTINGS/Xcalclient Configuration in the left navigation bar of Xcalscan.

To turn on Xcalclient

      • For Linux, type $ cd “ your Xcalclient path” in the terminal and run Xcalclient with $ ./start.sh
      • For Windows, go to the Xcalclient folder and click start.bat

To turn off Xcalclient

      • Type Ctrl+C in the terminal or close the terminal to turn off Xcalclient.

Please note that if Xcalclient is not installed or turned on then certain features of Xcalscan that require the client cannot be used. These include scanning new projects, rescanning existing projects, or modifying the settings of projects. In the case that you attempt to use these features, you will be reminded to install and turn on Xcalclient.