Oculix - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #llm #android #deep-learning #docker #nodejs #macos #java #awesome #awesome-list #pytorch #mcp

Oculix

(★ 139)

OculiX — Visual Automation IDE. If you can see it, you can automate it.

파일 탐색기

최종 버전 다운로드 (.zip)

- prepare-commit-msg
- - oculix-on-suse.png
- - codeql-config.yml
- - bug_report.yml
  - config.yml
  - documentation.yml
  - epic.yml
  - feature_request.yml
  - gecko.yml
  - native_platform.yml
  - regression.yml
  - translation_issue.yml
- - api-compile.yml
  - api-snapshot.yml
  - codeql.yml
  - ide-compile.yml
  - ocr-perf-bench.yml
  - plublish-maven.yml
  - project-status-sync.yml
  - release-rc.yml
  - release.yml
  - strip-status-on-close.yml
  - test-macos-launch.yml
  - test-mouse-preflight.yml
- CODEOWNERS
- CREDITS.md
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- - oculix-build-extensions.jar
- jvm.config
- maven.config
- CDC-Operix-DotNet.md
- CDC-Operix-NodeJS.md
- CDC-Operix-Python.md
- makeapi-lux.xml
- makeapi-mac.xml
- makeapi-win.xml
- pom.xml
- README.md
- - 396-pub400-f3-lives.png
- pom.xml
- CDC-Apertix-M1-Support.md
- makeide-lux.xml
- makeide-mac.xml
- makeide-win.xml
- makeide.xml
- pom.xml
- README.md
- pom.xml
- README.md
- pom.xml
- merge-staging-to-live.py
- test_merge_staging_to_live.py
- sikulix-red.png
- test-cli.py
- compile.yml
- dependabot.yml
- publish-maven.yml
- IDE_ar.properties
- IDE_bg.properties
- IDE_bn.properties
- IDE_ca.properties
- IDE_da.properties
- IDE_de.properties
- IDE_es.properties
- IDE_he.properties
- IDE_hi.properties
- IDE_it.properties
- IDE_ja.properties
- IDE_ko.properties
- IDE_nl.properties
- IDE_pl.properties
- IDE_pt_BR.properties
- IDE_ru.properties
- IDE_sv.properties
- IDE_te.properties
- IDE_tr.properties
- IDE_uk.properties
- IDE_zh_CN.properties
- IDE_zh_TW.properties
.gitignore
.java-version
.mailmap
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
pom.xml
README.md
RELEASE_NOTES.md
SECURITY.md
tigervnc-java-oculix.bundle

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

<img src="IDE/src/main/resources/icons/gecko_cyclope_hero.png" width="240" alt="OculiX"/>

# OculiX

**The open-source reference for visual automation.**
*Twenty years of lineage. MIT-licensed. Trusted in production by 91+ organizations worldwide.*

[![Java](https://img.shields.io/badge/Java-11%2B-orange?style=flat-square&logo=openjdk)](https://adoptium.net)
[![License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](https://raw.githubusercontent.com/oculix-org/Oculix/master/LICENSE)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/12878/badge)](https://www.bestpractices.dev/projects/12878)
[![Version](https://img.shields.io/badge/Version-3.0.3-blue?style=flat-square)](https://github.com/oculix-org/Oculix/releases)
[![Docs](https://img.shields.io/badge/Docs-oculix.org-blueviolet?style=flat-square)](https://oculix.org)
[![Maven Central](https://img.shields.io/badge/Maven%20Central-io.github.oculix--org-blue?style=flat-square&logo=apachemaven)](https://central.sonatype.com/namespace/io.github.oculix-org)

[**Get started**](https://oculix.org/getting-started/installation/) · [**Documentation**](https://oculix.org) · [**Enterprise**](https://oculix.org/support/enterprise/)

</div>

---

## Trusted in production

| 91 | 14k+ | 3.4k | MIT |
|---|---|---|---|
| enterprise organizations | clones every two weeks | Maven downloads / quarter | open source, forever |

---

## What OculiX is

OculiX drives any graphical interface by **what it looks like** — not by accessibility hooks, DOM selectors, or fragile XPaths. You point at what you see on screen, OculiX does the rest.

It works where selector-based tools cannot: native desktop applications, virtualized desktops (Citrix, RDP, VNC), Canvas/WebGL-rendered UIs, multi-application workflows, and any environment where what reaches the user is, ultimately, pixels.

You don't need to be a developer to use it. If you can take a screenshot, you can write your first OculiX script. If you *are* a developer, you get a full JVM scripting environment on top.

---

## A first script

```python
# Open the app, export today's report, save it — every morning at 8 AM.
from oculix import click, type, wait

click("file_menu.png")
click("export_to_csv.png")
wait("save_dialog.png", timeout=10)
type("filename_field.png", "report_today.csv")
click("save_button.png")
```

Full installation, first-script tutorial, and tour of the IDE at [**oculix.org/getting-started**](https://oculix.org/getting-started/installation/).

---

## What it brings

<table>
<tr>
<td width="50%">

**Pixel-perfect matching**
OpenCV-based template matching with DPI awareness, similarity tuning, sub-pixel reliability. Five matching strategies cascaded before FindFailed.

</td>
<td width="50%">

**OCR out of the box**
Tesseract embedded via Legerix, no manual install. PaddleOCR available as opt-in HTTP server for multilingual and CJK workloads.

</td>
</tr>
<tr>
<td width="50%">

**Cross-platform**
Windows, macOS, Linux. One script runs everywhere — no platform-specific selectors. Native libraries pre-built and bundled.

</td>
<td width="50%">

**Jython scripting**
Python 2.7 syntax with full JVM interop. Drop-in compatible with legacy SikuliX scripts. JRuby, Robot Framework, and PowerShell runners also supported.

</td>
</tr>
<tr>
<td width="50%">

**Full VNC stack**
Connect to any remote machine without a local display. `VNCScreen`, `VNCRobot`, complete X keysym mapping, thread-safe parallel sessions.

</td>
<td width="50%">

**Native SSH tunneling**
`SSHTunnel` utility with embedded JSch. Open tunnels from Java alone — no shell wrapper, no WSL.

</td>
</tr>
<tr>
<td width="50%">

**Android via ADB**
Full ADB integration over WiFi or USB. No Appium, no XPath, no accessibility API. Validated on Android 12+.

</td>
<td width="50%">

**Auditable execution**
Optional MCP module: Ed25519-signed, SHA-256-chained JSONL audit journal. Every action independently verifiable.

</td>
</tr>
</table>

---

## How it compares

OculiX sits in the **process automation** space alongside RPA and visual automation tools.

| Capability | OculiX | UiPath | Eggplant |
|---|---|---|---|
| License & cost | **MIT — free forever** | Commercial — per bot / per user | Commercial — enterprise license |
| Self-hosted, fully local | **100% local, no cloud needed** | Hybrid (Studio local, Orchestrator cloud) | On-prem available |
| Cross-platform | **Windows · macOS · Linux** | Studio is Windows-only | Windows · macOS · Linux |
| Approach | Pure visual — sees the screen | UI selectors (UIA/HTML) + visual fallback | Visual + IDE |
| Embedded OCR | **Tesseract bundled** | Multiple providers via marketplace | Built-in |
| Scripting language | Jython (Python 2.7 + JVM) | VB.NET · C# · Python (limited) | SenseTalk |
| Best fit | Anyone — non-tech users to enterprise teams | Enterprise RPA at scale | Visual test for regulated industries |

*Comparison based on each vendor's public documentation as of 2026. OculiX is independent and unaffiliated with UiPath (UiPath, Inc.) or Eggplant (Keysight Technologies).*

---

## Quick install

**Prerequisite:** Java 11 or later — [Eclipse Temurin](https://adoptium.net) or [Azul Zulu](https://www.azul.com/downloads/).

**Maven:**

```xml
<dependency>
    <groupId>io.github.oculix-org</groupId>
    <artifactId>oculixapi</artifactId>
    <version>3.0.3</version>
</dependency>
```

**From source:**

```bash
git clone https://github.com/oculix-org/Oculix.git
cd Oculix
mvn clean install -DskipTests
```

Detailed setup at [**oculix.org/getting-started/installation**](https://oculix.org/getting-started/installation/).

---

## Adopted by teams at

IBM · Qualcomm · Tencent · Alibaba · Kakao · Deutsche Bank · PepsiCo · Dassault Systèmes · Kaspersky · Synopsys · Neo4j · Zscaler · Jack Henry · RSA Security · Bill.com · University of Alberta

*Organizations with verified OculiX downloads on Maven Central. Names listed for informational purposes only — no endorsement, partnership, or affiliation is implied. Full list on the [adoption showcase](https://oculix.org/showcase/).*

---

## Where to next

| Need | Where |
|---|---|
| Install OculiX | [Get started](https://oculix.org/getting-started/installation/) |
| Your first script | [Hello-world tutorial](https://oculix.org/getting-started/first-script/) |
| OCR & text recognition | [OCR guide](https://oculix.org/guides/ocr/) |
| Bug reports & questions | [GitHub Issues](https://github.com/oculix-org/Oculix/issues) · [Discussions](https://github.com/oculix-org/Oculix/discussions) |
| Security vulnerability | [Private advisory](https://github.com/oculix-org/Oculix/security/advisories/new) — see [SECURITY.md](SECURITY.md) |
| Enterprise support | [Work with us](https://oculix.org/support/enterprise/) |

---

## Community tools & integrations

People are building things around OculiX. If your project deserves a mention here, open a Discussion or a PR — the bar is *"useful to someone in the OculiX ecosystem"*, not *"officially endorsed"*.

| Project | Author | What it brings |
|---|---|---|
| [**oculix-vscode**](https://github.com/MiguelDomingues/oculix-vscode) | [@MiguelDomingues](https://github.com/MiguelDomingues) | VS Code extension : region capture, inline image previews replacing PNG filenames in code, click-to-set target offsets, interactive `cv2.matchTemplate` testing, script runner. Consumes OculiX as a runtime JAR — the right architectural model for community tooling. |

---

## Contributing

Pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow, code style, and review expectations. Substantive changes are discussed in advance via an issue when possible.

Visible at [Contributors](https://github.com/oculix-org/Oculix/graphs/contributors).

---

## License & lineage

OculiX is released under the [MIT License](LICENSE). It is the active continuation of the Sikuli (Tom Yeh, MIT UIST 2009) and SikuliX (Raimund Hocke, 2010–2025) lineage. The `org.sikuli.*` package namespace and historical prose are preserved as a matter of respect to the foundations.

🦎