Sikuli Documentation

Getting Help

Looking for specific information?

See other people’s questions or ask a question yourself.

If you think you’ve found bugs, search or report bugs in our bug tracker.

This document is being maintained by the Sikuli Doc Team.

If you have any questions or ideas about this document, you are welcome to contact us.

For questions regarding the functions and features of Sikuli itself please use the Sikuli Questions and Answers Board.

For hints and links of how to get more information and help, please see the sidebar.

How to use this document

Sikuli Script is built as a Jython (Python for the Java platform) library. You can use any syntax of the Python language. If you are new to programming, you can still enjoy using Sikuli to automate simple repetitive tasks without learning Python. A good start might be to have a look at the tutorials.

However, if you would like to write more powerful and complex scripts, which might even be structured in modules, you have to dive into the Python Language.

The preface of each chapter in this documentaton briefly describes a class or a group of methods. It provides general usage information and hints that apply to all methods in that chapter. We recommend to read it through before using the related features.

If you are totally new with Sikuli, it might be a good idea to just read through this documentation sequentially. An alternative way might be to jump to the chapters that you are interested in by scanning the table of contents. A way in the middle would be reading the core classes: Region, then Match, and finally Screen.

For the users of the previous versions (0.9.x and 0.10.x) What’s new in Sikuli X is a good start. After that, you can go to any places of interest using the table of contents or use the Index to browse all classes, methods and functions in alphabetical order.