Sikulixserver - is it possible to respond stack trace, cause of the issue or even screenshot base64 string to the client?

[tianzso]

Hello!

Hope you're doing well.

It would be nice to see more detail when a script fails, other than:
PASS 200 runScript: returned: 1

Which is not really suitable for building a framework where the tests are executed via an http request, but when there is an issue we know nothing else then an integer: 1.

Can you please help me on this how can I achieve what I want? Or does this mean some additional development needed for the tool?

Thanks. Have a nice day!

[julienmerconsulting]

SikuliX is actively maintained again

Hi @tianzso,

The original maintainer (RaiMan) stepped away from the project for personal reasons after years of solo maintenance. The project is now actively maintained again under oculix-org.

That said — your request is legitimate. The SikulixServer response format is minimal by design (it was experimental), and returning only an exit code is indeed not enough for a proper test framework integration.

What you can do today

The SikulixServer is a thin HTTP wrapper around script execution. If you need detailed error reporting, a more robust approach is to:

1. Log from within your script — write errors, stack traces and screenshots to a known location
2. Use SikuliX via command line (java -jar sikulixide.jar -r yourscript.sikuli) and capture stdout/stderr from your framework
3. Use the Java API directly in your test framework (JUnit, TestNG, etc.) — full control over exceptions and reporting

About enhancing the server

Returning structured error responses (stack trace, failure reason, screenshot base64) from SikulixServer would require development effort. This is noted as a potential enhancement but is not prioritized at this time.

If this is critical for your use case, a pull request with a proposed implementation would be welcome.

---

Label: enhancement