Shortcuts for those who know:    ->Questions & Bugs     ->Docs     ->Sources    ->Translation
THIS PAGE IS NO LONGER UPDATED AFTER 10th of JUNE 2016
new homepage at
sikulix.com
SikuliX 1.1.0 is available  (2015-10-07)
... and on MavenCentral (com.sikulix::sikulixapi::1.1.0)

SikuliX blog now on Wordpress

...New in 1.1.0... Observe revised and with new features
...Read About... AnkuLua - SikuliX-like visual automation on Android (scripting with Lua).
...Read About... How does SikuliX find images on the screen?

Other interesting  stuff
Gave an interview about SikuliX on TestTalks driven by Joe Colantonio
ExtensiveTesting: GUI solution for Testers integrating Selenium and SikuliX

Experimental
- run scripts from anywhere with zero-delay 
- Support for Selenium and Robot Framework
For details and showcases see the Support tab.
Development of SikuliX2 as version 2.0.0 started in October 2015 
A gem for users of Ruby scripting (using JRuby)
There is a wrapper available for the Java API (sikulixapi.jar) as gem on ruby gems.org

What is Sikuli (now named SikuliX) ?

You might have heard of Sikuli IDE or Sikuli Script -- this all now is SikuliX.
It is somehow feature compatible to Sikuli Java API -- but usage is very different. 
SikuliX automates anything you see on the screen of your desktop computer running Windows, Mac or some Linux/Unix. It uses image recognition powered by OpenCV to identify and control GUI components. This is handy in cases when there is no easy access to a GUI's internals or the source code of the application or web page you want to act on.

SikuliX supports as scripting languages
  • Python language level 2.7 (supported by Jython)
  • Ruby language level 1.9 and 2.0 (supported by JRuby)
… and you can use it in Java programming and programming/scripting with any Java aware programming/scripting language (Jython, JRuby, Scala, Clojure, …).

Though SikuliX is currently not available on any mobile device, it can be used with the respective emulators on a desktop computer or based on VNC solutions.

Besides locating images on a screen SikuliX can run the mouse and the keyboard to interact with the identified GUI elements. This is available for multi monitor environments and even for remote systems with some restrictions.

SikuliX comes with basic text recognition (OCR) and can be used to search text in images. This feature is powered by Tesseract.

SikuliX is a Java application, that works on Windows XP+, Mac 10.6+ and most Linux/Unix systems. For Windows, Mac and Ubuntu 12.04+ it is complete and should normally work out of the box. For other Linux/Unix systems there usually are a few prerequisites to be setup.

SikuliX is the follow up of Sikuli Script with it's last version from 2011 as Sikuli-X-1.0rc3.
Though it is no longer supported: here you find valuable information for the installation.

Why might I find SikuliX useful ?

You want to automate some repetetive tasks in
  • daily usage of applications or web pages
  • playing games
  • administration of IT systems and networks
... and you do not have adequate tools at hand.

You want to test applications or web pages, that are under development.

You want to create usage documentation or training material, that run live on the addressed application or web page. 

You already have tools and workflows for that, but you want to add the specific features of SikuliX to enhance your approach and improve efficiency and outcome.
Using SikuliX means doing WYSIWYS: What You See Is What You Script ;-)

How can I get SikuliX ?

Before thinking about using SikuliX, you have to assure, that you have a valid Java JRE installation (preferably version 7 or 8 latest). Though normally the SikuliX application can be started by just double clicking the respective SikuliX elements (either jar files or command scripts), it helps to be familiar with the usage of a command line window on your system for some more sophisticated usage cases.

SikuliX can be downloaded from Sikuli's Launchpad page.  What you download from there is sikulisetup-X.Y.Z.jar (where X.Y.Z is the version number - currently 1.1.0).

You should put it in a separate folder in a prominent place, since it is intended to stay there for ever ;-) together with other SikuliX artefacts you will get later on, either by will or because SikuliX creates them on the fly.

To finally get the ready-to-use SikuliX elements you have to run the setup.
But before downloading and fiddling around, it is highly recommended to read about the gory details in Getting Started.

How do I use SikuliX and where can I get help ?

With SikuliX there are two rather distinct usage scenarios:
Scripting
One sets up and runs more or less complex SikuliX workflows based on searching images and acting on GUI elements with mouse and keyboard. For this one uses the so called Sikuli IDE, that brings some basic support for editing and running scripts.
In the Scripting usage scenario, you handle Sikuli scripts named you-name-it.sikuli,  which are folders  containing the script file and the images you need for the workflow. You either run the scripts from within the Sikuli IDE or from the command line.

To get on the road you should at least once scan the docs.

Programming
In a mature IDE (Eclipse, NetBeans, ...) and/or some testing environment one integrates SikuliX as a feature library using the available API's while programming in Java or Java aware/based languages (Jython, JRuby, Scala, Clojure, ...).
If you work in this usage scenario, then
In any case you should have read the Getting Started section.

How can I contribute ?

The sources and hence the development base is on GitHub :: SikuliX-2014, where you will find everything, that you need to know.
Every kind of contribution is always welcome and highly appreciated. 
Use any of the available channels, to get in contact.

Where does Sikuli come from ?

Sikuli in Huichol Indian is their word for a God’s Eye, meaning the power to see and understand things unknown. 
Sikuli was started somewhen in 2009 as an open-source research project at the User Interface Design Group at MIT by Tsung-Hsiang Chang (graduated in 2012) and Tom Yeh (now head of Sikuli Lab at Computer Sciences at Univeristy of Colorado).
Both during 2012 left the project on the level Sikuli-X-1.0rc3. In late 2012 I decided to take over the further development and support and name it SikuliX.
Original Sikuli Logo
The original Sikuli Logo

A wise man said

Reading to the end, before clicking around with intermediate links,
might get you to the solution on the direct way and possibly faster. 

Get it


Be sure to have visited QuickStart.
Changelog​
no longer supported (2015+)
​does not work with OS X 10.10+

Feedback

I have a question

The right place to ask any question about SikuliX is on Launchpad.
... and be aware of the FAQs section

I have a comment

Use one or more of the contact buttons at the top right of this page.
... or use the questions on Launchpad.

I think I found a bug

Use the bugs section on Launchpad.
... or post an issue on GitHub.

I have an idea for a new feature

Feel free to use any of the above ;-)

I want to contribute something

Preferably post an issue on GitHub.
... or use any of the above.

What RaiMan uses

IDE for development

NetBeans for Java and C++
with Maven support

Source version control

The source is hosted at GitHub.
As synch tool I use SourceTree.

Usage documentation

The docs are hosted at ReadTheDocs.
... and they use Sphinx.

Translation of GUI and docs

Trying to get a free account on
Transifex
the SikuliX project site

Other stuff

I mainly work on Mac OSX 10.9.
I have a Windows 8 machine.
Ubuntu, Windows XP and Windows 7 are running in VirtualBox.

Donations are welcome

In the past some people have asked, wether they might give some money, to keep up my motivation, to continue further development and enhancement of SikuliX.
I have decided, to make this possible.
Money I get, might allow me, to use 
non-free services to support SikuliX.
At least it is some compensation for my costs for keeping up my development environment and the hosting service.

Current costs/year for hosting
about 80$
Great thanks to these donators
Kiem Ton
Маслов Евгений
Evgeny Shragovich
Barry J Busler
Matthew Molloy
Mathias Krizanac