On this page

How to use AI code assistants with Squish

General Guidance

General guidance on Squish test script generation with AI code assistants, such as GitHub Copilot, Cursor, or Claude CLI, is given in the blog post A Practical Guide to Generating Squish Test Scripts with AI Assistants.

The guidance given especially considers:

  • Context
  • Fast iteration or feedback loop from test results to improvements.

Context includes everything from up-to-date Squish documentation to team-specific rules for test scripts.

Establishing a connection from the AI code assistant to running the test scripts and receiving the test results is needed to make the test script iteration faster. With the test results, the AI code assistant is able to fix errors autonomously.

There are at least two options for creating the connection between Squish and the AI code assistant:

  • Option A — Use Squish from the CLI in the AI code assistant

    Instruct and allow the AI code assistant to access squishrunner directly from the command line. See all flags and usage for squishrunner: squishrunner Command Line Reference.

  • Option B — Use Squish MCP example with your AI code assistant

    Note: The Squish MCP example is provided as a pre-release.

    Get the server from https://github.com/TheQtCompanyRnD/squish-mcp and follow the installation instructions in the readme file.

    For troubleshooting, see the section in the readme: Troubleshooting.

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.
The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.
Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Search Results