Skip to content

Download and install

Retool is supported on Windows 10+, Ubuntu 20+, and macOS 10+.

How you download and install Retool will depend on your level of comfort with code, and the operating system you use.

If you're a Windows user and want the easiest path, you can get Retool going in a few easy steps:

  1. Download the Windows binary ZIP file:

    retool-2.3.8-win-x86-64.zip

    SHA256: a9a4d4ec71dc8e3513441ab38f1b64b5ccb4d4f44c6d6e3f132cf79e980b2f6d

  2. Extract the ZIP file to a folder of your choosing.

  3. In that folder, double click retoolgui.exe. A Command Prompt window opens, which shows the output when Retool is running. Don't close it, as this also closes the GUI.

  4. Click File > Update clone lists to download the latest clone lists and metadata files.

Note

Retool's binary is UPX packed to reduce its size on disk. This means that some over-zealous anti-virus software might pick it up as a false positive. If the SHA256 of the downloaded ZIP matches the checksum on this page, you're likely safe to mark an exception in your anti-virus software.

If you're more comfortable with the command line, or are running on a non-Windows platform, then this option is for you.

  1. Download and install Python 3.10 or higher, if you haven't already.

  2. Clone Retool from its repository:

    git clone https://github.com/unexpectedpanda/retool.git

  3. Install Retool's dependencies, either with Pip or Hatch:

    pip install alive-progress lxml psutil pyside6 darkdetect strictyaml validators

    1. Install Hatch if you haven't already:

      pip install hatch

    2. Enter the Hatch virtual environment:

      hatch shell

      To exit the environment at any time, run the exit command.

    Info

    On systems that have both Python 2 and 3 installed, you might need to run pip3 instead of pip.

  4. Download the latest clone lists and metadata files:

    retool.py --update

    Info

    On some operating systems you might need to prefix Python files with python3 or python to run them.

  5. You can now run retool.py or retoolgui.py.

Linux issues

If you get a libxcb error in Linux when launching retoolgui, this fixed the problem for me in Ubuntu 20.04:

sudo apt-get install libxcb-randr0-dev \
        libxcb-xtest0-dev libxcb-xinerama0-dev libxcb-shape0-dev libxcb-xkb-dev