Golang API

Golang API Runtime And Reference

Connect the live runtime concepts to the generated API reference and the deeper integration guides.

Runtime Connection

The public runtime entry point is:

runtime, err := sikuli.NewRuntime("127.0.0.1:50051")

If the address is empty, the runtime code falls back to SIKULI_GRPC_ADDR and then to the default 127.0.0.1:50051.

Useful runtime options include:

  • WithRuntimeAuthToken
  • WithRuntimeRPCTimeout
  • WithRuntimeDialTimeout
  • WithRuntimeMatcherEngine
  • WithRuntimeConn
  • WithRuntimeContextDialer

Runtime Surface

From Runtime, the main live entry points are:

  • Screens()
  • PrimaryScreen()
  • Screen(id)
  • Capture()
  • CaptureRegion(region)
  • Region(region)

From live Screen and LiveRegion, the main operations include:

  • Find
  • Exists
  • Wait
  • WaitVanish
  • ReadText
  • FindText
  • CollectWords
  • CollectLines
  • Click, Hover, RightClick, DoubleClick

Generated Reference

Use the generated reference when you need exported symbol detail rather than a guide summary:

The generated pages are script-owned and should not be hand-edited.

Next Pages