Node.js Client

Node.js Client Installation

Install the Node package, scaffold a working project, and optionally install the runtime binaries on PATH.

Who This Page Is For

Use this page when Node.js is the primary entry point and you need package install and bootstrap guidance before writing scripts.

Fastest Path

yarn dlx @sikuligo/sikuli-go init:js-examples

This scaffolds a project directory, writes package.json, installs the current package dependency, and copies .mjs examples into examples/.

Package Install

If you are wiring the package into an existing project, use the published package:

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

Install The Runtime On PATH

yarn dlx @sikuligo/sikuli-go install-binary

This installs sikuli-go and sikuli-go-monitor into ~/.local/bin.

Verify The Node Path

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

Next Pages