@sikuligo/sikuli-go

v0.1.76

Published

19 days ago

sikuli-go Node.js client

0High
0Medium
0Low

sikuli sikulix sikuli go automation testing recorder replay visual desktop gui screen image pattern scripting e2e blackbox bot rpa robot framework

sikuli-go (Node.js)

sikuli-go is a Go implementation of Sikuli visual automation. This package provides the Node.js SDK for launching sikuli-go locally and executing automation with a small API surface.

Canonical Documentation

Long-form Node.js docs now live in the published guide:

Quickstart

init:js-examples prompts for a target directory, scaffolds a package.json with the latest @sikuligo/sikuli-go dependency, runs yarn install, and copies .mjs examples into examples/.

yarn dlx @sikuligo/sikuli-go init:js-examples
cd sikuli-go-demo
yarn node examples/click.mjs

import { Screen, Pattern } from "@sikuligo/sikuli-go";

const screen = await Screen();
try {
  const match = await screen.click(Pattern("assets/pattern.png").exact());
  console.log(`clicked match target at (${match.targetX}, ${match.targetY})`);
} finally {
  await screen.close();
}

Install In An Existing Project

npm install @sikuligo/sikuli-go
# or
yarn add @sikuligo/sikuli-go

Runtime Helpers

Install the runtime binaries on PATH:

yarn dlx @sikuligo/sikuli-go install-binary

Start the runtime and dashboard:

yarn dlx @sikuligo/sikuli-go -listen

Open:

http://127.0.0.1:8080/dashboard

Run the standalone monitor after installing the binaries:

sikuli-go-monitor

By default it serves the monitor UI on :8080 and reads sikuli-go.db from the current working directory.

Dashboard Preview

The local runtime exposes both the dashboard and the standalone monitor workflow described in the guide:

Dashboard Guide

Dashboard Screenshot

Monitor Screenshot

Common Package Entry Points

Screen() or Screen.start() uses auto mode
Screen.connect() attaches to an existing runtime
Screen.spawn() forces a new runtime process
screen.region(x, y, w, h) scopes the search area

For the full runtime model, diagnostics flow, and troubleshooting notes, use the Node.js guide pages above.

FindOnScreen Benchmark Test Results

Generated: 2026-03-07T23:32:15.506029+00:00

Reports

Engine Summary

Cases/OK metrics are query-level counts (regions x scenarios x resolutions), not just benchmark row count.

| Engine | Cases | OK | Partial | Not Found | Unsupported | Error | Overlap Miss | Avg ms/op | Median ms/op | |---|---:|---:|---:|---:|---:|---:|---:|---:|---:| | akaze | 120 | 39 | 0 | 78 | 0 | 0 | 3 | 172.121 | 147.695 | | brisk | 120 | 47 | 0 | 63 | 0 | 0 | 10 | 388.483 | 123.118 | | hybrid | 120 | 69 | 0 | 45 | 0 | 0 | 6 | 171.017 | 134.411 | | kaze | 120 | 63 | 0 | 50 | 0 | 0 | 7 | 824.898 | 640.512 | | orb | 120 | 13 | 0 | 96 | 0 | 0 | 11 | 56.443 | 44.794 | | sift | 120 | 56 | 0 | 55 | 0 | 0 | 9 | 256.756 | 198.264 | | template | 120 | 64 | 0 | 56 | 0 | 0 | 0 | 154.257 | 114.466 |