SikuliX (sikulix.jar)

The SikuliX launcher allows running test generated with SikuliX.


The sikuli.xml file is just a template and must NOT be edited. It's used by the system to build dynamically the form that the user will be able to fill in from the GUI when creating a custom execution configuration.

Parameter Description
Test Root Path This must indicate where are located all the Sikuli tests.
This is a root path. Each test in XStudio has a canonical path that will be appended to this path.
This path MUST not include an ending slash.

Default value is: C:/sikuli/tests
Install path This must indicate the path where SikuliX has been installed.

Default value is: C:/Program Files/Sikuli
Script extension This indicates the extension of the files to be executed

Default value is: .sikuli
Debug level (1-3) This indicates the debug level you want to capture

Default value is: 2
Sikuli Log file path This indicates where the sikuliX log file is generated

Default value is: C:/Users/john.doe/sikuli_log.txt
User Log file path This indicates where the user log file is stored

Default value is: C:/Users/john.doe/user_log.txt
Opt. arguments any optional arguments you may need to pass

These values can be changed while creating the campaign session from XStudio.

Note about file path parameters:

Any parameter referring to a file or folder path (for instance Test root path) can be provided either using \ separator (if the tests are going to be executed on a Windows agent) or / separator (if the tests are going to be executed on a linux or MacOSX agent).

On windows, if you provide a path containing a, OS-localizable folder such as C:\Program Files, always prefer the English version (i.e. NOT C:\Programmes if you're using a french-localized Windows) or the corresponding native environment variable (i.e. %PROGRAMFILES%).


The tests are executed by the launcher using this syntax:

"<installPath>/runsikulix.cmd" -d <debugLevel> -l "<sikuliLogFilePath>" -u "<userLogFilePath>" -c
-r "<testRootPath>/<testName>/<testcaseName><scriptExtension> -- <option>

"<installPath>/runsikulix" -d <debugLevel> -l "<sikuliLogFilePath>" -u "<userLogFilePath>" -c
-r "<testRootPath>/<testName>/<testcaseName><scriptExtension> -- <option>

This command is executed by the launcher from the following working directory: <testRootPath>


The useful files generated during test execution are uploaded to XStudio so that you can open/read them afterwards:
  • <sikuliTraceFile>
  • <sikuliLogFilePath>
  • <userLogFile>


The test cases will be marked as passed or failed depending on the result of the parsing of the Sikuli trace file (stored in <testRootPath>/<testPath>/sikuli_traces.txt).
The parsing is based on the prefix the system will see on each line:


If at least one message is having the Failure status, the test case is set as failed.


WARNING: if you're running your tests on Windows, it may be required to run the tests as administrator.
Having an account with Administrators permissions may even not be enough in some cases (especially if you're using Windows 10) and you may need to disable completely the UAC (User Access Control) on your computer.

To do so:
  • Press the Windows + R key combination
  • Type in regedit
  • Go to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System
  • In the right-side pane, look for EnableLUA and set the value 0
  • Close the registry editor
  • Restart your computer


If your tests are not executed correctly or are reporting only failures, this is very likely because your configuration is incorrect or because you used a wrong naming convention for your tests and test cases.

The best way to quickly find out what's wrong is to look at the traces generated by XStudio (or XAgent).
The traces always include the detailed description of what the launcher performs (command line execution, script execution, API calling etc.) to run a test case. So, if you experiment some problems, the first thing to do is to activate the traces and look at what's happening when you run your tests.

Then, try to execute manually in a cmd box the exact same commands.
This will normally fail the same way.
At this point, you needs to figure out what has to be changed in these commands in order to have them run properly.

When you have something working, compare these commands to what's described in the Process chapter above. This will tell you exactly what you need to change.

Most of the time, this is related to:
  • some incorrect values in some parameters of your configuration,
  • the name of your tests,
  • the name of your test cases,
  • the canonical path of your tests