How to Install Squish

This chapter explains how to install Squish on Windows, and on Unix-like systems such as Linux, macOS, and Embedded Linux.

Note: Supported Platforms

For up-to-date information about which platforms/operating systems (macOS, Windows and Linux) can run Squish, please see this knowledge base article.

Squish is supplied as a single, easy-to-install and set up binary package that contains the Tools and the IDE. Squish is also available in separate packages for when this is preferred or necessary—a Tools package in source form, and a separate binary for the Eclipse-based Squish IDE. (It is also possible to use Eclipse as your IDE by integrating the Squish IDE plugins into it. See Eclipse IDE Integration.)

In most cases Squish's command line tools can be successfully installed using binary packages, but there are some situations where it is necessary to build them from source.

The cases where it is not possible to use a standard build are when you want to test applications built with a non-standard Qt library or running on a platform that is not yet supported. If any of these applies, the following sections describe how to create and use a custom build of Squish from source in the relevant circumstances:

If you are testing Java or Web applications or native macOS or Windows applications, or Qt 4 applications using a standard (multi-threaded and shared) library, then using a binary package is the quickest and easiest way to get Squish up and running. The process is explained in Installing from Binary Packages.

Note: with Qt debug libraries

The prebuilt binary packages are built against release versions of the Qt libraries—not against the debug versions. If you want to use Squish with Qt debug libraries inquire with technical support about the availability of a debug version for your configuration. If not available you will need to build Squish from source. (See Installation for Testing Pure Qt 4 Applications.)

However, if for some reason—perhaps you are using an unusual Unix system or setup, or if you want to use Qt debug libraries—a binary package is not suitable, you can always build the tools from source. This is explained in the section Installing Squish for Qt from Desktop Source Packages, although it is also worth reading Configure Switches first, so that you know what options are available to you when you run configure.

If you want to use a Squish installation on more than one machine, you will find it helpful to read Distributing and Sharing an Installation.

Once the binary package is unpacked you can immediately start up the Squish IDE—its executable is SQUISHDIR\squishide.exe on Windows, SQUISHDIR/squishide on Unix, and SQUISHDIR/ on macOS.

Warning: iOS (e.g., iPhone and iPad) Testing

Note that iPhone and iPad applications can only be tested on Apple hardware—either on the devices themselves or on simulators that run under macOS.

Note: Uninstalling

When you unpack a Squish package it is put into the directory you specify. The Squish installation and setup do not not touch the Windows registry or interfere with any system files or directories—for example, Squish doesn't put any files in C:\Windows or /usr/bin.

The only files that Squish creates outside of its own directory are listed here:

  1. Configuration files stored in the Squish User Settings directory, by default in %APPDATA%\froglogic\Squish or ~/.squish.
  2. License file stored as %USERPROFILE%\.squish-3-license or ~/.squish-3-license.
  3. Test results written to %USERPROFILE%\My Documents\Squish Test Results or ~/.squish/Test Results.

If you want to uninstall Squish, run the SQUISHDIR/Uninstall script, or activate it from the corresponding applications menu item (Windows/MacOS). It is also ok to simply delete SQUISHDIR.

It is best to keep the license file and to leave the configuration files alone so that if you install a new version it will already have all your settings in place. However, if you want to do a complete uninstallation simply delete the configuration directory (and on Windows the test results directory), and the license file, in addition to the Squish directory.

© 2022 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.