Primary Guide

Downloads

Pick the shortest install path for the runtime, a client package, or a source-based development setup.

Who This Section Is For

Use this page when you are deciding how to get the runtime onto a machine:

  • pick a package-driven path for Node.js or Python
  • install the runtime binaries directly from a release
  • build from source for local development or release work

Fast Path

Path Use When Command Next Page
Node.js package You want the JavaScript client and example scaffolding yarn dlx @sikuligo/sikuli-go init:js-examples Node.js Client
Python package You want the Python client and example scaffolding pipx run sikuli-go init:py-examples Python Client
Runtime on PATH You want sikuli-go and sikuli-go-monitor available directly yarn dlx @sikuligo/sikuli-go install-binary or pipx run sikuli-go install-binary Getting Started
Source build You are developing in the repo or need generated artifacts make Build From Source

Distribution Channels

Node.js npm Package Use the published package to scaffold `.mjs` examples, bootstrap the runtime, and stay in a Node-first workflow. Python PyPI Package Use the published package to scaffold Python examples and keep runtime startup close to the script flow. Runtime GitHub Releases Fetch the published runtime artifacts directly when you only need the binaries. Development Build From Source Use the monorepo build and verification flow when you need local edits, generated stubs, or release preparation.

Common Tasks

Install The Runtime On PATH

yarn dlx @sikuligo/sikuli-go install-binary
# or
pipx run sikuli-go install-binary

Both flows can add ~/.local/bin to your shell config. Reload the shell after install if the command is not found immediately.

Install A Release Binary On Linux

VERSION="<release-tag>"
ARCH="amd64"
curl -fL "https://github.com/smysnk/SikuliGO/releases/download/${VERSION}/sikuli-go-linux-${ARCH}.tar.gz" \
  -o /tmp/sikuli-go.tar.gz
tar -xzf /tmp/sikuli-go.tar.gz -C /tmp
sudo install -m 0755 /tmp/sikuli-go /usr/local/bin/sikuli-go

Build In The Repository

make

Troubleshooting And Next Steps

Deeper References