Open-source project
oculix-org/SikuliX1 avatar
oculix-org/SikuliX1

SikuliX1 is a read-only Java mirror that points you at the Oculix fork

SikuliX version 2.0.0+ (2019+)

3,259 stars398 forksJavaMIT

At a glance

What is it?
oculix-org/SikuliX1 holds the legacy SikuliX1 code that found GUI elements with OpenCV and drove them with simulated input. The repository itself is a mirror: its own first page sends readers to the active Oculix fork, the documentation site and the archived upstream.
Who is it for?
Use oculix-org/SikuliX1 for reading, archaeology and understanding how the image-recognition approach was implemented, not for shipping new automation. Anyone starting a project today should follow the redirect to oculix-org/Oculix on Java 17 or newer, and anyone reproducing an old SikuliX1 job should check the tag names first, since three different v2.0.5 labels exist with dates five years apart.
Can I use it commercially?
Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
No. The owners have archived the repository on GitHub, so it is read-only and no longer receives changes.
What is it written in?
Mainly Java, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • oculix-org/SikuliX13,259 ★ · +12
Star history
Repository2026-09-242026-11-15
oculix-org/SikuliX13.2k3.3k

12 Stars in the last 52 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The first page is a redirect table, not documentation

The README opens with a table headed Where you probably want to go, and every row redirects rather than explains. Wanting to use SikuliX today sends you to oculix-org/Oculix, described as the active fork running Java 17 or newer with v3.0.3 stable and v4.0 in flight. Bug reports and feature requests go to oculix-org/Oculix/issues. Public documentation lives at docs.oculix.org. RaiMan's original upstream sits at RaiMan/SikuliX1, noted as archived in March 2026 by its creator. The last row is the one that describes the repository you are reading: browse the legacy SikuliX1 code, where you are here, read-only mirror. The subtitle above the title says the same thing in fewer words, calling this the historical SikuliX1 codebase mirrored under oculix-org. Treat anything you find in this tree as a reference implementation rather than a dependency. The mirroring also splits the community surface from the code: the four listed destinations cover running the tool, filing defects, reading reference pages and reviewing the original history, so a question about how SikuliX used to behave belongs in a read of this tree rather than in an issue filed here.

Three v2.0.5 tags, one of them labelled buggy

The release history does not read like a normal changelog. Three tags carry the same version number in different forms. A tag named v2.0.5 with the parenthetical SikuliX 2.0.5 is dated 2026-04-02, which is a re-stamp inside the mirror rather than a new version of the software. Two others sit 83 minutes apart on 2021-03-03: 2.0.5 (buggy version) at 09:30 and 2.0.5-final (2.0.5 revised) at 10:53. Someone tagging a build as the buggy version and then re-tagging a revised one within the same morning is naming releases for a specific reason, and a mirror that inherits those tags preserves the reason along with the confusion. The repository description anchors the scope differently, reading SikuliX version 2.0.0+ (2019+). Check which tag you are on before comparing behaviour.

Image recognition stands in for the DOM

The one substantive explanation of the technology is short and worth reading closely. SikuliX uses computer vision, via OpenCV, to identify and interact with anything visible on a screen, across Windows, macOS and Linux. It locates GUI elements through image recognition, then drives them with simulated mouse and keyboard input. The line that explains the design is the last one: no access to source code, DOM or accessibility APIs required. That is the entire contract, and it is why a screen-scraping approach outlived so many tool-specific alternatives. Anything drawn on screen is a target, and anything that changes its pixels becomes a different target. The original motto, still called valid in the README, puts it plainly: if you can see it, you can automate it. The tradeoff implied by that motto is resolution and rendering, which is why a tool built on screenshots inherits every styling change as a broken script.

API, IDE and Support sit at the top level

The tree shows how the project was split. API/ and IDE/ are the two large directories, which matches a tool that ships a scripting surface and a separate desktop environment for authoring scripts. Support/ and pages/ sit alongside them, and a pom.xml at the root marks the build as Maven based, with the Java toolchain driven from a manifest rather than an ad hoc script. Four small governance and metadata files are committed too: CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE and README.md, plus .github/ for automation and a .gitignore. A .java-version file records the JDK the project expects for its own tooling, a small file that matters more in a mirror than in a working checkout, because it is the only in-tree signal of which runtime the code was written against. The absence of any lockfile or bundler configuration at the root also fits: a Java build of this shape resolves from a single manifest rather than from a pinned dependency graph.

Four sets of hands across twenty-three years

The heritage section compresses the lineage into four dated entries and names the people. In 2003 the MIT CSAIL UI Design Group of Rob Miller launched the visual automation research project that would become Sikuli. In 2009, at the ACM Symposium on User Interface Software and Technology, doubleshow, Tom Yeh, and vgod, Tsung-Hsiang Chang, formally introduced Sikuli with a UIST paper, and the codebase eventually landed under the sikuli GitHub organization. From 2010 to 2023 RaiMan, Raimund Hocke, took over as sole maintainer, evolving the project through Java 8 to 11, multi-platform fixes and OCR integration across thirteen years of stewardship. In March 2026 RaiMan archived the upstream and transmitted stewardship, and development continued as OculiX. The license has not moved in any of those transitions: the MIT terms chosen at the start are still in force.

Java 8 through 11 here, Java 17 or newer in the fork

The runtime gap between this mirror and the fork it points to is the most concrete reason to stop reading here when you mean to build. RaiMan's tenure is described as moving the project through Java 8 to 11, and that is the ceiling this code targets. The active fork is described as Java 17 or newer, on OpenCV 4.10 via Apertix, with a working VNC stack, Android 12 or newer ADB, a PaddleOCR option and 22 native-reviewed locales. Each of those is a feature that has to be implemented against a newer language level, and the OCR direction is visible in the older history too, where OCR integration appears among the multi-platform fixes of the 2010 to 2023 period. Two branches of the same project, one at Java 11 and one at 17, means scripts written for one are not automatically valid on the other even though the calling convention looks identical. The fork's own feature list reads like the list of things that got hard on a newer JDK: a new OpenCV build, a working VNC stack for remote desktops, and ADB against a much newer Android.

The last push landed on 2026-07-24

The repository is not marked archived, yet its own text calls it read-only, and the two facts are not in conflict: a mirror can receive a sync commit without receiving new development. The recorded last push is 2026-07-24, which is months after the March 2026 handover to oculix-org and four months before the v2.0.5 tag that appeared on 2026-04-02. The homepage field still points at sikulix.com while the documentation row of the redirect table points at docs.oculix.org. What lands in a mirror is decided by the mirror, not by the upstream project's needs, so a recent commit date here carries no information about whether work is happening. Check the activity of oculix-org/Oculix directly rather than inferring it from this repository's history.

Editorial conclusion

Use oculix-org/SikuliX1 for reading, archaeology and understanding how the image-recognition approach was implemented, not for shipping new automation. Anyone starting a project today should follow the redirect to oculix-org/Oculix on Java 17 or newer, and anyone reproducing an old SikuliX1 job should check the tag names first, since three different v2.0.5 labels exist with dates five years apart.

Frequently asked questions

What is sikuli used for?

SikuliX uses computer vision through OpenCV to identify and interact with anything visible on a screen across Windows, macOS and Linux. It locates GUI elements with image recognition, then drives them with simulated mouse and keyboard input, and it needs no access to source code, DOM or accessibility APIs.

Is oculix-org/SikuliX1 still where you get SikuliX?

No. The README calls this the historical SikuliX1 codebase mirrored under oculix-org and a read-only mirror of the legacy code. It sends users to oculix-org/Oculix as the active fork on Java 17 or newer with v3.0.3 stable and v4.0 in flight, and notes that RaiMan's original upstream was archived in March 2026 by its creator.

What license is SikuliX1 released under?

MIT. The README states that the MIT license chosen 23 years ago is still in place today, and the repository commits a LICENSE file at the top level next to CODE_OF_CONDUCT.md and CONTRIBUTING.md.

Which Java version does SikuliX1 code target?

The repository is Java, built from a pom.xml and pinned by a .java-version file. RaiMan's tenure from 2010 to 2023 is described as evolving the project through Java 8 to 11, while the active Oculix fork is described as Java 17 or newer on OpenCV 4.10.

Where is the documentation for SikuliX1 today?

The redirect table sends readers to docs.oculix.org for the public documentation, and to oculix-org/Oculix/issues for bug reports and feature requests. The homepage recorded for this repository is sikulix.com.

Official sources

  1. License: MIT
  2. oculix-org/SikuliX1 on GitHub
  3. Project website
  4. README
  5. Releases
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/oculix-org-sikulix1.svg)](https://hysenlabs.com/projects/oculix-org-sikulix1)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/oculix-org-sikulix1.svg)](https://hysenlabs.com/projects/oculix-org-sikulix1)

Was this useful?